{ "smithy": "2.0", "shapes": { "com.amazonaws.bedrockagentruntime#APISchema": { "type": "union", "members": { "s3": { "target": "com.amazonaws.bedrockagentruntime#S3Identifier", "traits": { "smithy.api#documentation": "
Contains details about the S3 object containing the OpenAPI schema for the action group.
" } }, "payload": { "target": "com.amazonaws.bedrockagentruntime#Payload", "traits": { "smithy.api#documentation": "The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
" } } }, "traits": { "smithy.api#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.
" } }, "com.amazonaws.bedrockagentruntime#AWSResourceARN": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$" } }, "com.amazonaws.bedrockagentruntime#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.bedrockagentruntime#NonBlankString" } }, "traits": { "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.bedrockagentruntime#ActionGroupExecutor": { "type": "union", "members": { "lambda": { "target": "com.amazonaws.bedrockagentruntime#LambdaResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } }, "customControl": { "target": "com.amazonaws.bedrockagentruntime#CustomControlMethod", "traits": { "smithy.api#documentation": " To return the action group invocation results directly in the InvokeInlineAgent response, specify RETURN_CONTROL.
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.
" } }, "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput": { "type": "structure", "members": { "actionGroupName": { "target": "com.amazonaws.bedrockagentruntime#ActionGroupName", "traits": { "smithy.api#documentation": "The name of the action group.
" } }, "verb": { "target": "com.amazonaws.bedrockagentruntime#Verb", "traits": { "smithy.api#documentation": "The API method being used, based off the action group.
" } }, "apiPath": { "target": "com.amazonaws.bedrockagentruntime#ApiPath", "traits": { "smithy.api#documentation": "The path to the API to call, based off the action group.
" } }, "parameters": { "target": "com.amazonaws.bedrockagentruntime#Parameters", "traits": { "smithy.api#documentation": "The parameters in the Lambda input event.
" } }, "requestBody": { "target": "com.amazonaws.bedrockagentruntime#RequestBody", "traits": { "smithy.api#documentation": "The parameters in the request body for the Lambda input event.
" } }, "function": { "target": "com.amazonaws.bedrockagentruntime#Function", "traits": { "smithy.api#documentation": "The function in the action group to call.
" } }, "executionType": { "target": "com.amazonaws.bedrockagentruntime#ExecutionType", "traits": { "smithy.api#documentation": "How fulfillment of the action is handled. For more information, see Handling fulfillment of the action.
" } }, "invocationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the invocation. Only returned if the executionType is RETURN_CONTROL.
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.
" } }, "com.amazonaws.bedrockagentruntime#ActionGroupInvocationOutput": { "type": "structure", "members": { "text": { "target": "com.amazonaws.bedrockagentruntime#ActionGroupOutputString", "traits": { "smithy.api#documentation": "The JSON-formatted string returned by the API invoked by the action group.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Contains information about the action group output.
" } } }, "traits": { "smithy.api#documentation": "Contains the JSON-formatted string returned by the API invoked by the action group.
" } }, "com.amazonaws.bedrockagentruntime#ActionGroupName": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ActionGroupOutputString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ActionGroupSignature": { "type": "enum", "members": { "AMAZON_USERINPUT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMAZON.UserInput" } }, "AMAZON_CODEINTERPRETER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AMAZON.CodeInterpreter" } }, "ANTHROPIC_COMPUTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANTHROPIC.Computer" } }, "ANTHROPIC_BASH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANTHROPIC.Bash" } }, "ANTHROPIC_TEXTEDITOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANTHROPIC.TextEditor" } } } }, "com.amazonaws.bedrockagentruntime#ActionGroupSignatureParams": { "type": "map", "key": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "max": 100 } } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "max": 100 } } } }, "com.amazonaws.bedrockagentruntime#ActionInvocationType": { "type": "enum", "members": { "RESULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESULT" } }, "USER_CONFIRMATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_CONFIRMATION" } }, "USER_CONFIRMATION_AND_RESULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USER_CONFIRMATION_AND_RESULT" } } } }, "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields": { "type": "map", "key": { "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFieldsKey" }, "value": { "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFieldsValue" } }, "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFieldsKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFieldsValue": { "type": "document" }, "com.amazonaws.bedrockagentruntime#AgentActionGroup": { "type": "structure", "members": { "actionGroupName": { "target": "com.amazonaws.bedrockagentruntime#ResourceName", "traits": { "smithy.api#documentation": "The name of the action group.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentruntime#ResourceDescription", "traits": { "smithy.api#documentation": "A description of the action group.
" } }, "parentActionGroupSignature": { "target": "com.amazonaws.bedrockagentruntime#ActionGroupSignature", "traits": { "smithy.api#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 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.
" } }, "apiSchema": { "target": "com.amazonaws.bedrockagentruntime#APISchema", "traits": { "smithy.api#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.
" } }, "functionSchema": { "target": "com.amazonaws.bedrockagentruntime#FunctionSchema", "traits": { "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" } }, "parentActionGroupSignatureParams": { "target": "com.amazonaws.bedrockagentruntime#ActionGroupSignatureParams", "traits": { "smithy.api#documentation": "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.
" } }, "com.amazonaws.bedrockagentruntime#AgentActionGroups": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgentActionGroup" } }, "com.amazonaws.bedrockagentruntime#AgentAliasArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$" } }, "com.amazonaws.bedrockagentruntime#AgentAliasId": { "type": "string", "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#pattern": "^[0-9a-zA-Z]+$" } }, "com.amazonaws.bedrockagentruntime#AgentCollaboration": { "type": "enum", "members": { "SUPERVISOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUPERVISOR" } }, "SUPERVISOR_ROUTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUPERVISOR_ROUTER" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.bedrockagentruntime#AgentCollaboratorInputPayload": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#PayloadType", "traits": { "smithy.api#documentation": "The input type.
" } }, "text": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorPayloadString", "traits": { "smithy.api#documentation": "Input text.
" } }, "returnControlResults": { "target": "com.amazonaws.bedrockagentruntime#ReturnControlResults", "traits": { "smithy.api#documentation": "An action invocation result.
" } } }, "traits": { "smithy.api#documentation": "Input for an agent collaborator. The input can be text or an action invocation result.
" } }, "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationInput": { "type": "structure", "members": { "agentCollaboratorName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The collaborator's name.
" } }, "agentCollaboratorAliasArn": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", "traits": { "smithy.api#documentation": "The collaborator's alias ARN.
" } }, "input": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorInputPayload", "traits": { "smithy.api#documentation": "Text or action invocation result input for the collaborator.
" } } }, "traits": { "smithy.api#documentation": "An agent collaborator invocation input.
" } }, "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationOutput": { "type": "structure", "members": { "agentCollaboratorName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The output's agent collaborator name.
" } }, "agentCollaboratorAliasArn": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", "traits": { "smithy.api#documentation": "The output's agent collaborator alias ARN.
" } }, "output": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorOutputPayload", "traits": { "smithy.api#documentation": "The output's output.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Contains information about the output from the agent collaborator.
" } } }, "traits": { "smithy.api#documentation": "Output from an agent collaborator.
" } }, "com.amazonaws.bedrockagentruntime#AgentCollaboratorOutputPayload": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#PayloadType", "traits": { "smithy.api#documentation": "The type of output.
" } }, "text": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorPayloadString", "traits": { "smithy.api#documentation": "Text output.
" } }, "returnControlPayload": { "target": "com.amazonaws.bedrockagentruntime#ReturnControlPayload", "traits": { "smithy.api#documentation": "An action invocation result.
" } } }, "traits": { "smithy.api#documentation": "Output from an agent collaborator. The output can be text or an action invocation result.
" } }, "com.amazonaws.bedrockagentruntime#AgentCollaboratorPayloadString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#AgentCoreMemoryActorId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of an end user or agent that a session belongs to. This value scopes session history so that one actor's history is never returned for another.
", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_/]*(?::[a-zA-Z0-9\\-_/]+)*[a-zA-Z0-9\\-_/]*$" } }, "com.amazonaws.bedrockagentruntime#AgentCoreMemoryId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of an AgentCore Memory resource used with this retrieval.
", "smithy.api#length": { "min": 12, "max": 111 }, "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,99}-[a-zA-Z0-9]{10}$" } }, "com.amazonaws.bedrockagentruntime#AgentCoreMemorySessionId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of a session in an AgentCore Memory resource.
", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" } }, "com.amazonaws.bedrockagentruntime#AgentId": { "type": "string", "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#pattern": "^[0-9a-zA-Z]+$" } }, "com.amazonaws.bedrockagentruntime#AgentTraces": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#TracePart" } }, "com.amazonaws.bedrockagentruntime#AgentVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5 }, "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveAction": { "type": "structure", "members": { "retrieve": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveActionDetails", "traits": { "smithy.api#documentation": "Details of the retrieve action.
" } }, "fullDocumentExpansion": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveFullDocExpansionDetails", "traits": { "smithy.api#documentation": "Details of a full document expansion action.
" } }, "memoryRetrieve": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryRetrieveDetails", "traits": { "smithy.api#documentation": "The details of a long-term memory retrieval that the agent chose to perform.
" } }, "codeExecution": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCodeExecutionDetails", "traits": { "smithy.api#documentation": "The details of code that the agent chose to run.
" } } }, "traits": { "smithy.api#documentation": "An action taken during agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveActionDetails": { "type": "structure", "members": { "inputQuery": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessageContent", "traits": { "smithy.api#documentation": "The input query used for retrieval.
", "smithy.api#required": {} } }, "sourceRetrievers": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetrieverList", "traits": { "smithy.api#documentation": "The list of source retrievers targeted by this action.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Details of a retrieve action including the query and target retrievers.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveActions": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveAction", "traits": { "smithy.api#documentation": "A single retrieval action.
" } }, "traits": { "smithy.api#documentation": "List of actions taken during an agentic retrieval step.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveAppliedInstruction": { "type": "structure", "members": { "id": { "target": "com.amazonaws.bedrockagentruntime#RetrievalInstructionId", "traits": { "smithy.api#documentation": "The identifier of the retrieval instruction applied.
", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.bedrockagentruntime#RetrievalInstructionVersion", "traits": { "smithy.api#documentation": "The version that was applied: a version number, or DRAFT. The service reports this version whenever it reports appliedInstruction, including DRAFT when the request did not specify a version.
" } } }, "traits": { "smithy.api#documentation": "The retrieval instruction, identified by its ID and version, that was applied to the request.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockGuardrailConfiguration": { "type": "structure", "members": { "guardrailId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the guardrail.
", "smithy.api#length": { "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+$", "smithy.api#required": {} } }, "guardrailVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The version of the guardrail to use.
", "smithy.api#length": { "min": 1, "max": 5 }, "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for a Bedrock guardrail applied during agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockRerankingConfiguration": { "type": "structure", "members": { "modelConfiguration": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockRerankingModelConfiguration", "traits": { "smithy.api#documentation": "The model configuration containing the model ARN.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for a Bedrock reranking model.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockRerankingModelConfiguration": { "type": "structure", "members": { "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { "smithy.api#documentation": "The ARN of the Bedrock reranking model.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Model configuration for a Bedrock reranking model.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitation": { "type": "structure", "members": { "startIndex": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Character offset start in the answer text.
", "smithy.api#required": {} } }, "endIndex": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Character offset end (exclusive) in the answer text.
", "smithy.api#required": {} } }, "references": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationReferenceList", "traits": { "smithy.api#documentation": "References to results that support this span.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A citation mapping a span of the generated answer to supporting results.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitation" }, "traits": { "smithy.api#documentation": "List of citations.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationReference": { "type": "structure", "members": { "resultIndex": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Index into the results array on the same event.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A reference to a specific result item.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationReferenceList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationReference" }, "traits": { "smithy.api#documentation": "List of citation references.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveCodeExecutionDetails": { "type": "structure", "members": { "documents": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCodeExecutionDocumentList", "traits": { "smithy.api#documentation": "The documents that the code reads. This field is present when the code reads documents.
" } } }, "traits": { "smithy.api#documentation": "The details of code that the agent chose to run in an isolated sandbox. The record includes the documents that the code reads. The corresponding CodeExecution step reports the outcome.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveCodeExecutionDocument": { "type": "structure", "members": { "documentId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the document.
" } }, "sourceRetriever": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever", "traits": { "smithy.api#documentation": "The source retriever associated with the document.
" } } }, "traits": { "smithy.api#documentation": "A document that a code execution action reads.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveCodeExecutionDocumentList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCodeExecutionDocument", "traits": { "smithy.api#documentation": "A document read by the code.
" } }, "traits": { "smithy.api#documentation": "The documents read by a code execution action.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveConfiguration": { "type": "structure", "members": { "foundationModelType": { "target": "com.amazonaws.bedrockagentruntime#FoundationModelType", "traits": { "smithy.api#default": "MANAGED", "smithy.api#documentation": "The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.
" } }, "foundationModelConfiguration": { "target": "com.amazonaws.bedrockagentruntime#FoundationModelConfiguration", "traits": { "smithy.api#documentation": "The foundation model configuration. Required when foundationModelType is CUSTOM.
" } }, "rerankingModelType": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingModelType", "traits": { "smithy.api#documentation": "The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.
" } }, "rerankingConfiguration": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingConfiguration", "traits": { "smithy.api#documentation": "The reranking model configuration. Required when rerankingModelType is CUSTOM.
" } }, "maxAgentIteration": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": 5, "smithy.api#documentation": "The maximum number of agent iterations for retrieval.
", "smithy.api#range": { "min": 0 } } } }, "traits": { "smithy.api#documentation": "Configuration settings for the agentic retrieval operation.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveFailure": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the failure.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A failure that occurred during agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveFailures": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveFailure", "traits": { "smithy.api#documentation": "A single failure.
" } }, "traits": { "smithy.api#documentation": "List of failures that occurred during agentic retrieval.
", "smithy.api#length": { "min": 1 } } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveFullDocExpansionDetails": { "type": "structure", "members": { "documentId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the document to expand.
" } }, "sourceRetriever": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever", "traits": { "smithy.api#documentation": "The source retriever associated with the document.
" } } }, "traits": { "smithy.api#documentation": "Details of a full document expansion action.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveGeneratedResponse": { "type": "structure", "members": { "answer": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The generated answer text.
", "smithy.api#required": {} } }, "citations": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveCitationList", "traits": { "smithy.api#documentation": "Citations mapping spans of the answer to supporting results.
" } } }, "traits": { "smithy.api#documentation": "The generated response synthesized from retrieved results.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveGuardrailWarning": { "type": "structure", "members": { "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the guardrail.
", "smithy.api#required": {} } }, "version": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The version of the guardrail.
", "smithy.api#required": {} } }, "action": { "target": "com.amazonaws.bedrockagentruntime#GuardrailAction", "traits": { "smithy.api#documentation": "The action taken by the guardrail.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the guardrail evaluation result.
" } } }, "traits": { "smithy.api#documentation": "A warning generated by a guardrail during agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveInstructionConfiguration": { "type": "structure", "members": { "retrievalInstructionId": { "target": "com.amazonaws.bedrockagentruntime#RetrievalInstructionId", "traits": { "smithy.api#documentation": "The identifier of the retrieval instruction. The instruction must exist in the caller's account and its status must be ACTIVE.
", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.bedrockagentruntime#RetrievalInstructionVersion", "traits": { "smithy.api#documentation": "The version of the retrieval instruction to apply: a version number, or DRAFT for the instruction's current reviewed content. When omitted, DRAFT is used. This default is permanent.
" } } }, "traits": { "smithy.api#documentation": "The retrieval instruction, identified by its ID and optional version, to apply to this request.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryConfiguration": { "type": "structure", "members": { "memoryId": { "target": "com.amazonaws.bedrockagentruntime#AgentCoreMemoryId", "traits": { "smithy.api#documentation": "The identifier of the AgentCore Memory resource to use. The resource must exist in your account and be in the ACTIVE state.
", "smithy.api#required": {} } }, "sessionBinding": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemorySessionBinding", "traits": { "smithy.api#documentation": "The short-term memory session whose history is restored for this retrieval. To persist the agent-generated answer to the session, omit persistenceMode or set it to DEFAULT. To leave the session unchanged, set persistenceMode to NONE. Supply session history through the existing messages parameter or through short-term memory, but not both.
" } }, "retrievalConfigs": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryRetrievalConfigList", "traits": { "smithy.api#documentation": "Specifies the long-term memory configuration the agent can retrieve from. The agent decides whether to retrieve and composes its own query. This field currently accepts at most one entry.
" } }, "persistenceMode": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryPersistenceMode", "traits": { "smithy.api#documentation": "Specifies whether the agent-generated answer is written back to the given short-term memory session, and applies only when sessionBinding is set. Valid values:
DEFAULT (default) \u2013 Specifies that the question and the agent-generated answer are persisted to the session as a single event. This value requires generateResponse to be true.
NONE \u2013 Specifies that the session is left unchanged.
Specifies an AgentCore Memory resource and how this retrieval uses it. Set sessionBinding to restore and continue a session. Set retrievalConfigs to let the agent retrieve from long-term memory. You must specify at least one of the two.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilter": { "type": "structure", "members": { "left": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilterLeft", "traits": { "smithy.api#documentation": "The metadata key that the expression evaluates.
", "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilterOperator", "traits": { "smithy.api#documentation": "The relationship that the metadata key and value must have for a memory record to match.
", "smithy.api#required": {} } }, "right": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilterRight", "traits": { "smithy.api#documentation": "The value that the expression compares the metadata key against. Supply this value for every operator except EXISTS and NOT_EXISTS.
" } } }, "traits": { "smithy.api#documentation": "A metadata filter expression, in the form accepted by the AgentCore Memory RetrieveMemoryRecords operation. The expression has a left operand that names the metadata key, an operator, and a right operand. For the EXISTS and NOT_EXISTS operators, omit the right operand.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilterLeft": { "type": "union", "members": { "metadataKey": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataKey", "traits": { "smithy.api#documentation": "The metadata key to filter on.
" } } }, "traits": { "smithy.api#documentation": "The left operand of a metadata filter expression. Set exactly one member.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilterList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilter", "traits": { "smithy.api#documentation": "A metadata filter expression.
" } }, "traits": { "smithy.api#documentation": "The metadata filter expressions applied to long-term memory retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilterOperator": { "type": "enum", "members": { "EQUALS_TO": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The EQUALS_TO operator matches memory records whose metadata value equals the supplied value.
", "smithy.api#enumValue": "EQUALS_TO" } }, "EXISTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The EXISTS operator matches memory records that carry the metadata key, whatever its value. This operator takes no right operand.
", "smithy.api#enumValue": "EXISTS" } }, "NOT_EXISTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The NOT_EXISTS operator matches memory records that do not carry the metadata key. This operator takes no right operand.
", "smithy.api#enumValue": "NOT_EXISTS" } }, "BEFORE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The BEFORE operator matches memory records whose timestamp metadata value falls before the supplied value.
", "smithy.api#enumValue": "BEFORE" } }, "AFTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The AFTER operator matches memory records whose timestamp metadata value falls after the supplied value.
", "smithy.api#enumValue": "AFTER" } }, "CONTAINS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The CONTAINS operator matches memory records whose metadata value contains the supplied value.
", "smithy.api#enumValue": "CONTAINS" } }, "GREATER_THAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The GREATER_THAN operator matches memory records whose numeric metadata value is greater than the supplied value.
", "smithy.api#enumValue": "GREATER_THAN" } }, "GREATER_THAN_OR_EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The GREATER_THAN_OR_EQUALS operator matches memory records whose numeric metadata value is greater than or equal to the supplied value.
", "smithy.api#enumValue": "GREATER_THAN_OR_EQUALS" } }, "LESS_THAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The LESS_THAN operator matches memory records whose numeric metadata value is less than the supplied value.
", "smithy.api#enumValue": "LESS_THAN" } }, "LESS_THAN_OR_EQUALS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The LESS_THAN_OR_EQUALS operator matches memory records whose numeric metadata value is less than or equal to the supplied value.
", "smithy.api#enumValue": "LESS_THAN_OR_EQUALS" } } }, "traits": { "smithy.api#documentation": "Specifies the relationship that a metadata key and value must have for a memory record to match a filter expression.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilterRight": { "type": "union", "members": { "metadataValue": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataValue", "traits": { "smithy.api#documentation": "The value to compare the metadata key against.
" } } }, "traits": { "smithy.api#documentation": "The right operand of a metadata filter expression. Set exactly one member.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataKey": { "type": "string", "traits": { "smithy.api#documentation": "The metadata key that a filter expression evaluates.
", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataStringList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataStringListItem", "traits": { "smithy.api#documentation": "A string value within the list.
" } }, "traits": { "smithy.api#documentation": "The string values that a filter expression compares against.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataStringListItem": { "type": "string", "traits": { "smithy.api#documentation": "A single string value within a metadata string list.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataStringValue": { "type": "string", "traits": { "smithy.api#documentation": "A single string metadata value that a filter expression compares against.
", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataValue": { "type": "union", "members": { "stringValue": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataStringValue", "traits": { "smithy.api#documentation": "A string value.
" } }, "numberValue": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "A numeric value.
" } }, "stringListValue": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataStringList", "traits": { "smithy.api#documentation": "A list of string values.
" } }, "dateTimeValue": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "A timestamp value in ISO 8601 UTC format.
" } } }, "traits": { "smithy.api#documentation": "A metadata value that a filter expression compares against. Set exactly one member.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryPersistenceMode": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Specifies that the question and the agent-generated answer are persisted to the session. This is the default when persistenceMode is omitted.
", "smithy.api#enumValue": "DEFAULT" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Specifies that the session is left unchanged.
", "smithy.api#enumValue": "NONE" } } }, "traits": { "smithy.api#documentation": "Specifies whether the agent-generated answer is written back to a short-term memory session.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryRetrievalConfig": { "type": "structure", "members": { "namespace": { "target": "com.amazonaws.bedrockagentruntime#MemoryNamespace", "traits": { "smithy.api#documentation": "The namespace prefix to filter memory records by. The agent retrieves memory records in namespaces that start with the provided prefix. You must specify either namespace or namespacePath.
" } }, "namespacePath": { "target": "com.amazonaws.bedrockagentruntime#MemoryNamespace", "traits": { "smithy.api#documentation": "The parent namespace to use for hierarchical retrievals. The agent retrieves all memory records whose namespace falls under the same parent hierarchy. You must specify either namespace or namespacePath.
" } }, "strategyId": { "target": "com.amazonaws.bedrockagentruntime#MemoryStrategyId", "traits": { "smithy.api#documentation": "The extraction strategy ID that restricts retrieval to memory records produced by a single strategy. Omit this parameter to retrieve records from every strategy on the memory resource.
" } }, "metadataFilters": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryMetadataFilterList", "traits": { "smithy.api#documentation": "The metadata filter expressions that restrict retrieval to matching memory records. You can specify a maximum of 5 expressions.
" } } }, "traits": { "smithy.api#documentation": "The long-term memory namespace that the agent might retrieve memory records from, and the filters applied to that retrieval. You must specify either namespace or namespacePath.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryRetrievalConfigList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryRetrievalConfig", "traits": { "smithy.api#documentation": "A long-term memory namespace that the agent might retrieve memory records from.
" } }, "traits": { "smithy.api#documentation": "The long-term memory namespaces that the agent might retrieve memory records from.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryRetrieveDetails": { "type": "structure", "members": { "inputQuery": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessageContent", "traits": { "smithy.api#documentation": "The query that the agent composed.
", "smithy.api#required": {} } }, "memoryId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the AgentCore Memory resource retrieved from.
", "smithy.api#required": {} } }, "namespace": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The namespace prefix retrieved from, as supplied in the request. This field is present when the request specified namespace.
" } }, "namespacePath": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The parent namespace retrieved from hierarchically, as supplied in the request. This field is present when the request specified namespacePath.
" } }, "strategyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The extraction strategy that restricted retrieval, if the request specified one.
" } } }, "traits": { "smithy.api#documentation": "A long-term memory retrieval that the agent chose to perform. The record reports the query and the namespace. The corresponding Retrieval step reports the results.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemorySessionBinding": { "type": "structure", "members": { "actorId": { "target": "com.amazonaws.bedrockagentruntime#AgentCoreMemoryActorId", "traits": { "smithy.api#documentation": "The identifier of the end user or agent that the session belongs to. This identifier scopes session history so that one actor's history is never returned for another. You are responsible for sending the correct actor value.
", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.bedrockagentruntime#AgentCoreMemorySessionId", "traits": { "smithy.api#documentation": "The identifier of the session to restore and continue. You are responsible for sending the correct session value.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The short-term memory session that this retrieval reads from and writes to.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessage": { "type": "structure", "members": { "content": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessageContent", "traits": { "smithy.api#documentation": "The content of the message.
", "smithy.api#required": {} } }, "role": { "target": "com.amazonaws.bedrockagentruntime#ConversationRole", "traits": { "smithy.api#documentation": "The role of the message sender (e.g., user or assistant).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A message in the agentic retrieval conversation.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessageContent": { "type": "structure", "members": { "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The text content of the message.
" } } }, "traits": { "smithy.api#documentation": "The content of an agentic retrieval message.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessages": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessage", "traits": { "smithy.api#documentation": "A single message in the conversation.
" } }, "traits": { "smithy.api#documentation": "List of messages in the agentic retrieval conversation.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveMetadata": { "type": "map", "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The metadata key.
" } }, "value": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The metadata value.
" } }, "traits": { "smithy.api#documentation": "Metadata key-value pairs associated with a retrieved item.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrievePolicyConfiguration": { "type": "structure", "members": { "bedrockGuardrailConfiguration": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockGuardrailConfiguration", "traits": { "smithy.api#documentation": "Configuration for Bedrock guardrails to apply during retrieval.
" } } }, "traits": { "smithy.api#documentation": "Policy configuration for agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingConfiguration": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingConfigurationType", "traits": { "smithy.api#documentation": "The type of reranking configuration.
", "smithy.api#required": {} } }, "bedrockRerankingConfiguration": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveBedrockRerankingConfiguration", "traits": { "smithy.api#documentation": "The Bedrock reranking model configuration.
" } } }, "traits": { "smithy.api#documentation": "Configuration for the reranking model.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingConfigurationType": { "type": "enum", "members": { "BEDROCK_RERANKING_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" } } }, "traits": { "smithy.api#documentation": "The type of reranking configuration.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveRerankingModelType": { "type": "enum", "members": { "CUSTOM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM" } }, "MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGED" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } }, "traits": { "smithy.api#documentation": "The type of reranking model.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveResponseEvent": { "type": "structure", "members": { "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The generated text chunk.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A chunk of the generated answer text.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveResultEvent": { "type": "structure", "members": { "results": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveResults", "traits": { "smithy.api#documentation": "The list of retrieved result items.
", "smithy.api#required": {} } }, "generatedResponse": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveGeneratedResponse", "traits": { "smithy.api#documentation": "The generated response. Present only when generateResponse is true.
" } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#documentation": "Opaque continuation token for paginated results.
" } } }, "traits": { "smithy.api#documentation": "An event containing agentic retrieval results.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveResultItem": { "type": "structure", "members": { "content": { "target": "com.amazonaws.bedrockagentruntime#RetrievalContent", "traits": { "smithy.api#documentation": "The retrieved content.
", "smithy.api#required": {} } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMetadata", "traits": { "smithy.api#documentation": "Metadata associated with the retrieved item.
" } }, "sourceRetriever": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever", "traits": { "smithy.api#documentation": "The source retriever that produced this result.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A single item from the agentic retrieval results.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveResults": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveResultItem", "traits": { "smithy.api#documentation": "A single retrieval result item.
" } }, "traits": { "smithy.api#documentation": "List of agentic retrieval result items.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceMetadata": { "type": "structure", "members": { "identifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the retrieval source.
" } }, "retrievalType": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveType", "traits": { "smithy.api#documentation": "The type of retrieval source.
" } } }, "traits": { "smithy.api#documentation": "Metadata about a retrieval source.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceMetadataList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceMetadata", "traits": { "smithy.api#documentation": "Metadata for a retrieval source.
" } }, "traits": { "smithy.api#documentation": "List of retrieval source metadata.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever": { "type": "structure", "members": { "identifier": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the source retriever.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A source retriever that produced retrieval results.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetrieverList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever", "traits": { "smithy.api#documentation": "A source retriever.
" } }, "traits": { "smithy.api#documentation": "List of source retrievers.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The step is currently in progress.
", "smithy.api#enumValue": "IN_PROGRESS" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The step completed successfully.
", "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The step failed.
", "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "The status of an agentic retrieval step.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveStep": { "type": "enum", "members": { "PLANNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The planning phase of retrieval.
", "smithy.api#enumValue": "Planning" } }, "RETRIEVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The retrieval phase where data is fetched.
", "smithy.api#enumValue": "Retrieval" } }, "SPECULATIVE_RETRIEVAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "A speculative retrieval phase for optimization.
", "smithy.api#enumValue": "SpeculativeRetrieval" } }, "FULL_DOCUMENT_EXPANSION": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The full document expansion phase.
", "smithy.api#enumValue": "FullDocumentExpansion" } }, "SESSION_HISTORY_LOAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The phase that restores prior session history from AgentCore Memory short-term memory, before the agent begins work.
", "smithy.api#enumValue": "SessionHistoryLoad" } }, "CODE_EXECUTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The phase that runs agent-generated code in an isolated sandbox. The code can read documents retrieved earlier in the same request.
", "smithy.api#enumValue": "CodeExecution" } } }, "traits": { "smithy.api#documentation": "The step in the agentic retrieval process.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveStream": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information from one or more knowledge bases using an agentic approach. Agentic retrieval uses a foundation model to intelligently decompose complex queries into sub-queries and iteratively retrieve relevant information from your knowledge bases. This approach improves retrieval accuracy for complex, multi-step questions that a single retrieval pass might not fully address.
The operation returns results through a stream that includes retrieval results, trace events for visibility into the process, and a generated response synthesized from the results by default, which can be turned off.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/agenticRetrieveStream" } } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamRequest": { "type": "structure", "members": { "messages": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMessages", "traits": { "smithy.api#documentation": "The list of messages for the agentic retrieval conversation.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "retrievers": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrievers", "traits": { "smithy.api#documentation": "The list of retrievers to use for agentic retrieval.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "agenticRetrieveConfiguration": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveConfiguration", "traits": { "smithy.api#documentation": "Configuration settings for the agentic retrieval operation.
", "smithy.api#required": {} } }, "policyConfiguration": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrievePolicyConfiguration", "traits": { "smithy.api#documentation": "Policy configuration for guardrails and content filtering.
" } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#documentation": "Opaque continuation token for paginated results.
" } }, "userContext": { "target": "com.amazonaws.bedrockagentruntime#UserContext", "traits": { "smithy.api#documentation": "Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.
" } }, "memoryConfiguration": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMemoryConfiguration", "traits": { "smithy.api#documentation": "The configuration for using an Amazon Bedrock AgentCore Memory resource with this retrieval.
" } }, "retrievalInstructionConfiguration": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveInstructionConfiguration", "traits": { "smithy.api#documentation": "A retrieval instruction to apply to this request.
" } }, "generateResponse": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "Whether to generate a response based on the retrieved results.
" } } }, "traits": { "smithy.api#documentation": "Request structure for the agentic retrieve stream operation.
", "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStream" } ] }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResponse": { "type": "structure", "members": { "stream": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResponseOutput", "traits": { "smithy.api#documentation": "The output stream containing retrieval results and trace events.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Response structure for the agentic retrieve stream operation.
", "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResponseOutput": { "type": "union", "members": { "result": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveResultEvent", "traits": { "smithy.api#documentation": "A retrieval result event containing the retrieved items.
" } }, "traceEvent": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceEvent", "traits": { "smithy.api#documentation": "A trace event providing visibility into the retrieval process.
" } }, "responseEvent": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveResponseEvent", "traits": { "smithy.api#documentation": "A chunk of the generated answer. Emitted only when generateResponse is true.
" } }, "internalServerException": { "target": "com.amazonaws.bedrockagentruntime#InternalServerException", "traits": { "smithy.api#documentation": "An internal server error occurred.
" } }, "validationException": { "target": "com.amazonaws.bedrockagentruntime#ValidationException", "traits": { "smithy.api#documentation": "The request validation failed.
" } }, "resourceNotFoundException": { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", "traits": { "smithy.api#documentation": "The specified resource was not found.
" } }, "serviceQuotaExceededException": { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", "traits": { "smithy.api#documentation": "The service quota has been exceeded.
" } }, "throttlingException": { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", "traits": { "smithy.api#documentation": "The request was throttled.
" } }, "accessDeniedException": { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", "traits": { "smithy.api#documentation": "Access to the resource was denied.
" } }, "conflictException": { "target": "com.amazonaws.bedrockagentruntime#ConflictException", "traits": { "smithy.api#documentation": "A conflict occurred with the current state of the resource.
" } }, "dependencyFailedException": { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", "traits": { "smithy.api#documentation": "A dependency failed during the operation.
" } }, "badGatewayException": { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", "traits": { "smithy.api#documentation": "A bad gateway error occurred.
" } } }, "traits": { "smithy.api#documentation": "The streaming output for agentic retrieval, containing results, traces, and errors.
", "smithy.api#streaming": {} } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceEvent": { "type": "structure", "members": { "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the trace event.
", "smithy.api#required": {} } }, "timestamp": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The timestamp when the trace event occurred.
", "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceEventAttributes", "traits": { "smithy.api#documentation": "The attributes describing the trace event details.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A trace event providing visibility into the agentic retrieval process.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceEventAttributes": { "type": "structure", "members": { "step": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStep", "traits": { "smithy.api#documentation": "The current step in the retrieval process.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStatus", "traits": { "smithy.api#documentation": "The status of the current step.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A human-readable message describing the trace event.
", "smithy.api#required": {} } }, "actions": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveActions", "traits": { "smithy.api#documentation": "The list of actions taken during this step.
" } }, "warnings": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarnings", "traits": { "smithy.api#documentation": "Warnings generated during this step.
" } }, "failures": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveFailures", "traits": { "smithy.api#documentation": "Failures that occurred during this step.
" } }, "retrievalMetadata": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceMetadataList", "traits": { "smithy.api#documentation": "Metadata about the retrieval sources used.
" } }, "retrievalResponse": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceResults", "traits": { "smithy.api#documentation": "The retrieval results from this step.
" } }, "appliedInstruction": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveAppliedInstruction", "traits": { "smithy.api#documentation": "The agent reports the retrieval instruction applied to this request on the first planning step.
" } } }, "traits": { "smithy.api#documentation": "Attributes describing the details of an agentic retrieval trace event.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceResultItem": { "type": "structure", "members": { "content": { "target": "com.amazonaws.bedrockagentruntime#RetrievalContent", "traits": { "smithy.api#documentation": "The retrieved content.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveMetadata", "traits": { "smithy.api#documentation": "Metadata associated with the retrieved item.
" } }, "sourceRetriever": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveSourceRetriever", "traits": { "smithy.api#documentation": "The source retriever that produced this result.
" } } }, "traits": { "smithy.api#documentation": "A result item from an agentic retrieval trace.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceResults": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveTraceResultItem", "traits": { "smithy.api#documentation": "A single trace result item.
" } }, "traits": { "smithy.api#documentation": "List of trace result items from agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveType": { "type": "enum", "members": { "BEDROCK_KNOWLEDGE_BASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "A Bedrock knowledge base retrieval source.
", "smithy.api#enumValue": "BedrockKnowledgeBase" } }, "BEDROCK_AGENT_CORE_MEMORY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "An AgentCore Memory resource. Long-term memory retrievals report under the Retrieval step with this source type.
", "smithy.api#enumValue": "BedrockAgentCoreMemory" } } }, "traits": { "smithy.api#documentation": "The type of retrieval source.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarning": { "type": "union", "members": { "message": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarningMessage", "traits": { "smithy.api#documentation": "A general warning message.
" } }, "guardrail": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveGuardrailWarning", "traits": { "smithy.api#documentation": "A warning from a guardrail evaluation.
" } } }, "traits": { "smithy.api#documentation": "A warning generated during agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarningMessage": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The warning message text.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A general warning message from agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarnings": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveWarning", "traits": { "smithy.api#documentation": "A single warning.
" } }, "traits": { "smithy.api#documentation": "List of warnings generated during agentic retrieval.
", "smithy.api#length": { "min": 1 } } }, "com.amazonaws.bedrockagentruntime#AgenticRetriever": { "type": "structure", "members": { "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the retriever's purpose.
" } }, "configuration": { "target": "com.amazonaws.bedrockagentruntime#RetrieverConfiguration", "traits": { "smithy.api#documentation": "The configuration for this retriever.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A retriever used in agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AgenticRetrievers": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#AgenticRetriever", "traits": { "smithy.api#documentation": "A retriever configuration.
" } }, "traits": { "smithy.api#documentation": "List of retrievers for agentic retrieval.
" } }, "com.amazonaws.bedrockagentruntime#AmazonBedrockAgentRunTimeService": { "type": "service", "version": "2023-07-26", "resources": [ { "target": "com.amazonaws.bedrockagentruntime#AgenticRetrieveStreamResource" }, { "target": "com.amazonaws.bedrockagentruntime#CheckIngestedDocumentAclResource" }, { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionResource" }, { "target": "com.amazonaws.bedrockagentruntime#FlowResource" }, { "target": "com.amazonaws.bedrockagentruntime#GenerateQueryResource" }, { "target": "com.amazonaws.bedrockagentruntime#GetDocumentContentResource" }, { "target": "com.amazonaws.bedrockagentruntime#GetIngestedDocumentAclResource" }, { "target": "com.amazonaws.bedrockagentruntime#InferenceResource" }, { "target": "com.amazonaws.bedrockagentruntime#InlineAgentResource" }, { "target": "com.amazonaws.bedrockagentruntime#MemoryResource" }, { "target": "com.amazonaws.bedrockagentruntime#OptimizePromptResource" }, { "target": "com.amazonaws.bedrockagentruntime#RerankResource" }, { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResource" }, { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResource" }, { "target": "com.amazonaws.bedrockagentruntime#RetrieveResource" }, { "target": "com.amazonaws.bedrockagentruntime#SessionResource" }, { "target": "com.amazonaws.bedrockagentruntime#TaggingResource" } ], "traits": { "aws.api#service": { "sdkId": "Bedrock Agent Runtime", "arnNamespace": "bedrock", "endpointPrefix": "bedrock-agent-runtime", "cloudTrailEventSource": "bedrock.amazonaws.com" }, "aws.auth#sigv4": { "name": "bedrock" }, "aws.protocols#restJson1": { "http": [ "h2", "http/1.1" ], "eventStreamHttp": [ "h2", "http/1.1" ] }, "smithy.api#documentation": "Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see Amazon Bedrock Agents Classic availability change.
Contains APIs related to model invocation and querying of knowledge bases.
", "smithy.api#title": "Agents for Amazon Bedrock Runtime", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://bedrock-agent-runtime-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://bedrock-agent-runtime.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://bedrock-agent-runtime.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.bedrockagentruntime#AnalyzePromptEvent": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A message describing the analysis of the prompt.
" } } }, "traits": { "smithy.api#documentation": "An event in which the prompt was analyzed in preparation for optimization.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ApiContentMap": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "com.amazonaws.bedrockagentruntime#PropertyParameters" } }, "com.amazonaws.bedrockagentruntime#ApiInvocationInput": { "type": "structure", "members": { "actionGroup": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The action group that the API operation belongs to.
", "smithy.api#required": {} } }, "httpMethod": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The HTTP method of the API operation.
" } }, "apiPath": { "target": "com.amazonaws.bedrockagentruntime#ApiPath", "traits": { "smithy.api#documentation": "The path to the API operation.
" } }, "parameters": { "target": "com.amazonaws.bedrockagentruntime#ApiParameters", "traits": { "smithy.api#documentation": "The parameters to provide for the API request, as the agent elicited from the user.
" } }, "requestBody": { "target": "com.amazonaws.bedrockagentruntime#ApiRequestBody", "traits": { "smithy.api#documentation": "The request body to provide for the API request, as the agent elicited from the user.
" } }, "actionInvocationType": { "target": "com.amazonaws.bedrockagentruntime#ActionInvocationType", "traits": { "smithy.api#documentation": "Contains information about the API operation to invoke.
" } }, "agentId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The agent's ID.
" } }, "collaboratorName": { "target": "com.amazonaws.bedrockagentruntime#Name", "traits": { "smithy.api#documentation": "The agent collaborator's name.
" } } }, "traits": { "smithy.api#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": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The data type for the parameter.
" } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The value of the parameter.
" } } }, "traits": { "smithy.api#documentation": "Information about a parameter to provide to the API request.
This data type is used in the following API operations:
" } }, "com.amazonaws.bedrockagentruntime#ApiParameters": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#ApiParameter" } }, "com.amazonaws.bedrockagentruntime#ApiPath": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ApiRequestBody": { "type": "structure", "members": { "content": { "target": "com.amazonaws.bedrockagentruntime#ApiContentMap", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#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:
" } }, "com.amazonaws.bedrockagentruntime#ApiResult": { "type": "structure", "members": { "actionGroup": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The action group that the API operation belongs to.
", "smithy.api#required": {} } }, "httpMethod": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The HTTP method for the API operation.
" } }, "apiPath": { "target": "com.amazonaws.bedrockagentruntime#ApiPath", "traits": { "smithy.api#documentation": "The path to the API operation.
" } }, "confirmationState": { "target": "com.amazonaws.bedrockagentruntime#ConfirmationState", "traits": { "smithy.api#documentation": "Controls the API operations or functions to invoke based on the user confirmation.
" } }, "responseState": { "target": "com.amazonaws.bedrockagentruntime#ResponseState", "traits": { "smithy.api#documentation": "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
" } }, "httpStatusCode": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "http status code from API execution response (for example: 200, 400, 500).
" } }, "responseBody": { "target": "com.amazonaws.bedrockagentruntime#ResponseBody", "traits": { "smithy.api#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.
The agent's ID.
" } } }, "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#documentation": "Contains citations for a part of an agent response.
" } }, "com.amazonaws.bedrockagentruntime#AudioSegment": { "type": "structure", "members": { "s3Uri": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The S3 URI where this specific audio segment is stored in the multimodal storage destination.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "transcription": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The text transcription of the audio segment content.
" } } }, "traits": { "smithy.api#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 \u2013 in the audio field
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.
" } } }, "traits": { "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
", "smithy.api#error": "server", "smithy.api#httpError": 502 } }, "com.amazonaws.bedrockagentruntime#BasePromptTemplate": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#BedrockFoundationModelConfiguration": { "type": "structure", "members": { "modelConfiguration": { "target": "com.amazonaws.bedrockagentruntime#BedrockFoundationModelModelConfiguration", "traits": { "smithy.api#documentation": "The model configuration containing the model ARN.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for a Bedrock foundation model.
" } }, "com.amazonaws.bedrockagentruntime#BedrockFoundationModelModelConfiguration": { "type": "structure", "members": { "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { "smithy.api#documentation": "The ARN of the Bedrock foundation model.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Model configuration for a Bedrock foundation model.
" } }, "com.amazonaws.bedrockagentruntime#BedrockModelArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#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})?$" } }, "com.amazonaws.bedrockagentruntime#BedrockModelConfigurations": { "type": "structure", "members": { "performanceConfig": { "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", "traits": { "smithy.api#documentation": "The performance configuration for the model.
" } } }, "traits": { "smithy.api#documentation": "Settings for a model called with InvokeAgent.
" } }, "com.amazonaws.bedrockagentruntime#BedrockRerankingConfiguration": { "type": "structure", "members": { "numberOfResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of results to return after reranking.
", "smithy.api#range": { "min": 1, "max": 1000 } } }, "modelConfiguration": { "target": "com.amazonaws.bedrockagentruntime#BedrockRerankingModelConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for a reranker model.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains configurations for an Amazon Bedrock reranker model.
" } }, "com.amazonaws.bedrockagentruntime#BedrockRerankingModelArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$" } }, "com.amazonaws.bedrockagentruntime#BedrockRerankingModelConfiguration": { "type": "structure", "members": { "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { "smithy.api#documentation": "The ARN of the reranker model.
", "smithy.api#required": {} } }, "additionalModelRequestFields": { "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", "traits": { "smithy.api#documentation": "A JSON object whose keys are request fields for the model and whose values are values for those fields.
" } } }, "traits": { "smithy.api#documentation": "Contains configurations for a reranker model.
" } }, "com.amazonaws.bedrockagentruntime#BedrockSessionContentBlock": { "type": "union", "members": { "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The text in the invocation step.
", "smithy.api#length": { "min": 1 } } }, "image": { "target": "com.amazonaws.bedrockagentruntime#ImageBlock", "traits": { "smithy.api#documentation": "The image in the invocation step.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#BedrockSessionContentBlocks": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#BedrockSessionContentBlock" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.bedrockagentruntime#ByteContentBlob": { "type": "blob", "traits": { "smithy.api#length": { "min": 1, "max": 10485760 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ByteContentDoc": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.bedrockagentruntime#Identifier", "traits": { "smithy.api#documentation": "The file name of the document contained in the wrapper object.
", "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.bedrockagentruntime#ContentType", "traits": { "smithy.api#documentation": "The MIME type of the document contained in the wrapper object.
", "smithy.api#required": {} } }, "data": { "target": "com.amazonaws.bedrockagentruntime#ByteContentBlob", "traits": { "smithy.api#documentation": "The byte value of the file to upload, encoded as a Base-64 string.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "This property contains the document to chat with, along with its attributes.
" } }, "com.amazonaws.bedrockagentruntime#ByteContentFile": { "type": "structure", "members": { "mediaType": { "target": "com.amazonaws.bedrockagentruntime#MimeType", "traits": { "smithy.api#documentation": "The MIME type of data contained in the file used for chat.
", "smithy.api#required": {} } }, "data": { "target": "com.amazonaws.bedrockagentruntime#ByteContentBlob", "traits": { "smithy.api#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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The property contains the file to chat with, along with its attributes.
" } }, "com.amazonaws.bedrockagentruntime#Caller": { "type": "union", "members": { "agentAliasArn": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", "traits": { "smithy.api#documentation": "The caller's agent alias ARN.
" } } }, "traits": { "smithy.api#documentation": "Details about a caller.
" } }, "com.amazonaws.bedrockagentruntime#CallerChain": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Caller" } }, "com.amazonaws.bedrockagentruntime#CheckIngestedDocumentAcl": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#CheckIngestedDocumentAclRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#CheckIngestedDocumentAclResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Checks whether a user has access to a specific document by verifying against the ingested access control list (ACL) in a knowledge base. Use this operation to validate that document-level access control is working as expected after ingestion. To use this operation, you must have the bedrock:CheckIngestedDocumentAcl permission.
The unique identifier of the knowledge base that contains the document.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagentruntime#DataSourceId", "traits": { "smithy.api#documentation": "The unique identifier of the data source that contains the document.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "documentId": { "target": "com.amazonaws.bedrockagentruntime#DocumentId", "traits": { "smithy.api#documentation": "The unique identifier of the document to check access for.
", "smithy.api#required": {} } }, "userContext": { "target": "com.amazonaws.bedrockagentruntime#UserContext", "traits": { "smithy.api#documentation": "The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#CheckIngestedDocumentAclResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#CheckIngestedDocumentAcl" } ] }, "com.amazonaws.bedrockagentruntime#CheckIngestedDocumentAclResponse": { "type": "structure", "members": { "hasAccess": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether the user has access to the document based on the ingested access control list (ACL). Returns true if the user is allowed access, and false otherwise.
Contains the generated response and metadata
" } }, "retrievedReferences": { "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", "traits": { "smithy.api#documentation": "Contains metadata about the sources cited for the generated response.
" } } }, "traits": { "smithy.api#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 \u2013 in the citations field
RetrieveAndGenerate response \u2013 in the citations field
The citation.
" } }, "generatedResponsePart": { "target": "com.amazonaws.bedrockagentruntime#GeneratedResponsePart", "traits": { "smithy.api#documentation": "The generated response to the citation event.
" } }, "retrievedReferences": { "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", "traits": { "smithy.api#documentation": "The retrieved references of the citation event.
" } } }, "traits": { "smithy.api#documentation": "A citation event.
" } }, "com.amazonaws.bedrockagentruntime#Citations": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Citation" } }, "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationInput": { "type": "structure", "members": { "code": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The code for the code interpreter to use.
" } }, "files": { "target": "com.amazonaws.bedrockagentruntime#Files", "traits": { "smithy.api#documentation": "Files that are uploaded for code interpreter to use.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the code interpreter being invoked.
" } }, "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationOutput": { "type": "structure", "members": { "executionOutput": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Contains the successful output returned from code execution
" } }, "executionError": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Contains the error returned from code execution.
" } }, "files": { "target": "com.amazonaws.bedrockagentruntime#Files", "traits": { "smithy.api#documentation": "Contains output files, if generated by code execution.
" } }, "executionTimeout": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Indicates if the execution of the code timed out.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Contains information about the output from the code interpreter.
" } } }, "traits": { "smithy.api#documentation": "Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" } }, "com.amazonaws.bedrockagentruntime#CollaborationInstruction": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#Collaborator": { "type": "structure", "members": { "customerEncryptionKeyArn": { "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
" } }, "foundationModel": { "target": "com.amazonaws.bedrockagentruntime#ModelIdentifier", "traits": { "smithy.api#documentation": "The foundation model used by the inline collaborator agent.
", "smithy.api#required": {} } }, "instruction": { "target": "com.amazonaws.bedrockagentruntime#Instruction", "traits": { "smithy.api#documentation": "Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
", "smithy.api#required": {} } }, "idleSessionTTLInSeconds": { "target": "com.amazonaws.bedrockagentruntime#SessionTTL", "traits": { "smithy.api#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.
" } }, "actionGroups": { "target": "com.amazonaws.bedrockagentruntime#AgentActionGroups", "traits": { "smithy.api#documentation": "List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
" } }, "knowledgeBases": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBases", "traits": { "smithy.api#documentation": "Knowledge base associated with the inline collaborator agent.
" } }, "guardrailConfiguration": { "target": "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn", "traits": { "smithy.api#documentation": "Details of the guardwrail associated with the inline collaborator.
" } }, "promptOverrideConfiguration": { "target": "com.amazonaws.bedrockagentruntime#PromptOverrideConfiguration", "traits": { "smithy.api#documentation": "Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see Advanced prompts.
" } }, "agentCollaboration": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboration", "traits": { "smithy.api#documentation": "Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
" } }, "collaboratorConfigurations": { "target": "com.amazonaws.bedrockagentruntime#CollaboratorConfigurations", "traits": { "smithy.api#documentation": "Settings of the collaborator agent.
" } }, "agentName": { "target": "com.amazonaws.bedrockagentruntime#Name", "traits": { "smithy.api#documentation": " Name of the inline collaborator agent which must be the same name as specified for collaboratorName.
List of inline collaborators.
" } }, "com.amazonaws.bedrockagentruntime#CollaboratorConfiguration": { "type": "structure", "members": { "collaboratorName": { "target": "com.amazonaws.bedrockagentruntime#Name", "traits": { "smithy.api#documentation": " Name of the inline collaborator agent which must be the same name as specified for agentName.
Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
", "smithy.api#required": {} } }, "agentAliasArn": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the inline collaborator agent.
" } }, "relayConversationHistory": { "target": "com.amazonaws.bedrockagentruntime#RelayConversationHistory", "traits": { "smithy.api#documentation": "A relay conversation history for the inline collaborator agent.
" } } }, "traits": { "smithy.api#documentation": "Settings of an inline collaborator agent.
" } }, "com.amazonaws.bedrockagentruntime#CollaboratorConfigurations": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#CollaboratorConfiguration" } }, "com.amazonaws.bedrockagentruntime#Collaborators": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Collaborator" } }, "com.amazonaws.bedrockagentruntime#ConditionResultEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the condition node that evaluated the conditions.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the condition evaluation occurred.
", "smithy.api#required": {} } }, "satisfiedConditions": { "target": "com.amazonaws.bedrockagentruntime#SatisfiedConditions", "traits": { "smithy.api#documentation": "A list of conditions that were satisfied during the evaluation.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.bedrockagentruntime#ContentBlock": { "type": "union", "members": { "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The block's text.
" } } }, "traits": { "smithy.api#documentation": "A content block.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ContentBlocks": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#ContentBlock" } }, "com.amazonaws.bedrockagentruntime#ContentBody": { "type": "structure", "members": { "body": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The body of the API response.
" } }, "images": { "target": "com.amazonaws.bedrockagentruntime#ImageInputs", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#documentation": "A conversation history.
" } }, "com.amazonaws.bedrockagentruntime#ConversationRole": { "type": "enum", "members": { "USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "user" } }, "ASSISTANT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "assistant" } } } }, "com.amazonaws.bedrockagentruntime#CreateInvocation": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#CreateInvocationRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#CreateInvocationResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "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
", "smithy.api#http": { "code": 201, "method": "PUT", "uri": "/sessions/{sessionIdentifier}/invocations/" }, "smithy.api#idempotent": {} } }, "com.amazonaws.bedrockagentruntime#CreateInvocationRequest": { "type": "structure", "members": { "invocationId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "A unique identifier for the invocation in UUID format.
" } }, "description": { "target": "com.amazonaws.bedrockagentruntime#InvocationDescription", "traits": { "smithy.api#documentation": "A description for the interactions in the invocation. For example, \"User asking about weather in Seattle\".
" } }, "sessionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", "traits": { "smithy.api#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 unique identifier for the session associated with the invocation.
", "smithy.api#required": {} } }, "invocationId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier for the invocation.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the invocation was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#CreateSession": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#CreateSessionRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#CreateSessionResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#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:
", "smithy.api#http": { "code": 201, "method": "PUT", "uri": "/sessions/" }, "smithy.api#idempotent": {} } }, "com.amazonaws.bedrockagentruntime#CreateSessionRequest": { "type": "structure", "members": { "sessionMetadata": { "target": "com.amazonaws.bedrockagentruntime#SessionMetadataMap", "traits": { "smithy.api#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.
" } }, "encryptionKeyArn": { "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", "traits": { "smithy.api#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.
" } }, "tags": { "target": "com.amazonaws.bedrockagentruntime#TagsMap", "traits": { "smithy.api#documentation": "Specify the key-value pairs for the tags that you want to attach to the session.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#CreateSessionResponse": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier for the session.
", "smithy.api#required": {} } }, "sessionArn": { "target": "com.amazonaws.bedrockagentruntime#SessionArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the created session.
", "smithy.api#required": {} } }, "sessionStatus": { "target": "com.amazonaws.bedrockagentruntime#SessionStatus", "traits": { "smithy.api#documentation": "The current status of the session.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the session was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#CreationMode": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } }, "OVERRIDDEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OVERRIDDEN" } } } }, "com.amazonaws.bedrockagentruntime#CustomControlMethod": { "type": "enum", "members": { "RETURN_CONTROL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETURN_CONTROL" } } } }, "com.amazonaws.bedrockagentruntime#CustomOrchestration": { "type": "structure", "members": { "executor": { "target": "com.amazonaws.bedrockagentruntime#OrchestrationExecutor", "traits": { "smithy.api#documentation": "The structure of the executor invoking the actions in custom orchestration.
" } } }, "traits": { "smithy.api#documentation": "Contains details of the custom orchestration configured for the agent.
" } }, "com.amazonaws.bedrockagentruntime#CustomOrchestrationTrace": { "type": "structure", "members": { "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { "smithy.api#documentation": "The unique identifier of the trace.
" } }, "event": { "target": "com.amazonaws.bedrockagentruntime#CustomOrchestrationTraceEvent", "traits": { "smithy.api#documentation": "The event details used with the custom orchestration.
" } } }, "traits": { "smithy.api#documentation": "The trace behavior for the custom orchestration.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#CustomOrchestrationTraceEvent": { "type": "structure", "members": { "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The text that prompted the event at this step.
" } } }, "traits": { "smithy.api#documentation": "The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#DataSourceId": { "type": "string", "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#pattern": "^[0-9a-zA-Z]+$" } }, "com.amazonaws.bedrockagentruntime#DateTimestamp": { "type": "timestamp", "traits": { "smithy.api#documentation": "Time Stamp.", "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.bedrockagentruntime#DeleteAgentMemory": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes memory from the specified memory identifier.
", "smithy.api#http": { "code": 202, "method": "DELETE", "uri": "/agents/{agentId}/agentAliases/{agentAliasId}/memories" }, "smithy.api#idempotent": {} } }, "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryRequest": { "type": "structure", "members": { "agentId": { "target": "com.amazonaws.bedrockagentruntime#AgentId", "traits": { "smithy.api#documentation": "The unique identifier of the agent to which the alias belongs.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "agentAliasId": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", "traits": { "smithy.api#documentation": "The unique identifier of an alias of an agent.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "memoryId": { "target": "com.amazonaws.bedrockagentruntime#MemoryId", "traits": { "smithy.api#documentation": "The unique identifier of the memory.
", "smithy.api#httpQuery": "memoryId" } }, "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#documentation": "The unique session identifier of the memory.
", "smithy.api#httpQuery": "sessionId" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#DeleteAgentMemoryResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#DeleteSession": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#DeleteSessionRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#DeleteSessionResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#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.
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.
" } } }, "traits": { "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
", "smithy.api#error": "client", "smithy.api#httpError": 424 } }, "com.amazonaws.bedrockagentruntime#DocumentAcl": { "type": "structure", "members": { "allowList": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclMembership", "traits": { "smithy.api#documentation": "The list of principals allowed access to the document.
" } }, "denyList": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclMembership", "traits": { "smithy.api#documentation": "The list of principals denied access to the document.
" } } }, "traits": { "smithy.api#documentation": "The access control list for a document, containing allow and deny membership lists. Each list specifies conditions that determine which users and groups are granted or denied access.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#DocumentAclCondition": { "type": "structure", "members": { "conditionOperator": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclMemberRelation", "traits": { "smithy.api#documentation": "The logical operator for combining users and groups within this condition. Valid values: AND \u2013 Both a user match and a group match are required. OR \u2013 Either a user match or a group match is sufficient.
The list of user entries in this condition.
", "smithy.api#length": { "max": 3000 } } }, "groups": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclGroupList", "traits": { "smithy.api#documentation": "The list of group entries in this condition.
", "smithy.api#length": { "max": 3000 } } } }, "traits": { "smithy.api#documentation": "A condition within a document access control list (ACL) membership, specifying users and groups that are evaluated together.
" } }, "com.amazonaws.bedrockagentruntime#DocumentAclConditionList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclCondition" } }, "com.amazonaws.bedrockagentruntime#DocumentAclGroup": { "type": "structure", "members": { "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the group.
", "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^\\P{C}*$", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclMembershipType", "traits": { "smithy.api#documentation": "The membership type indicating the scope of the group entry.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A group entry within a document access control list (ACL) condition.
" } }, "com.amazonaws.bedrockagentruntime#DocumentAclGroupList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclGroup" } }, "com.amazonaws.bedrockagentruntime#DocumentAclMemberRelation": { "type": "enum", "members": { "AND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AND" } }, "OR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OR" } } }, "traits": { "smithy.api#documentation": "The logical relation for combining access control list (ACL) membership conditions.
" } }, "com.amazonaws.bedrockagentruntime#DocumentAclMembership": { "type": "structure", "members": { "memberRelation": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclMemberRelation", "traits": { "smithy.api#documentation": "The logical relation between conditions. Valid values: AND \u2013 All conditions must match. OR \u2013 At least one condition must match.
The list of conditions that determine membership.
", "smithy.api#length": { "max": 100 } } } }, "traits": { "smithy.api#documentation": "The membership entry for a document access control list (ACL), containing conditions and their logical relation.
" } }, "com.amazonaws.bedrockagentruntime#DocumentAclMembershipType": { "type": "enum", "members": { "KNOWLEDGE_BASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KNOWLEDGE_BASE" } }, "DATA_SOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DATA_SOURCE" } } }, "traits": { "smithy.api#documentation": "The scope type for a document access control list (ACL) membership condition. Valid values: KNOWLEDGE_BASE \u2013 The entry applies at the knowledge base level. DATA_SOURCE \u2013 The entry applies at the data source level.
The identifier of the user.
", "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^\\P{C}*$", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclMembershipType", "traits": { "smithy.api#documentation": "The membership type indicating the scope of the user entry.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A user entry within a document access control list (ACL) condition.
" } }, "com.amazonaws.bedrockagentruntime#DocumentAclUserList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#DocumentAclUser" } }, "com.amazonaws.bedrockagentruntime#DocumentId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1825 }, "smithy.api#pattern": "^\\P{C}*$" } }, "com.amazonaws.bedrockagentruntime#DocumentOutputFormat": { "type": "enum", "members": { "RAW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RAW" } }, "EXTRACTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXTRACTED" } } } }, "com.amazonaws.bedrockagentruntime#EndSession": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#EndSessionRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#EndSessionResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Ends the session. After you end a session, you can still access its content but you can\u2019t 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.
", "smithy.api#http": { "code": 200, "method": "PATCH", "uri": "/sessions/{sessionIdentifier}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.bedrockagentruntime#EndSessionRequest": { "type": "structure", "members": { "sessionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", "traits": { "smithy.api#documentation": "The unique identifier for the session to end. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The unique identifier of the session you ended.
", "smithy.api#required": {} } }, "sessionArn": { "target": "com.amazonaws.bedrockagentruntime#SessionArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session you ended.
", "smithy.api#required": {} } }, "sessionStatus": { "target": "com.amazonaws.bedrockagentruntime#SessionStatus", "traits": { "smithy.api#documentation": "The current status of the session you ended.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#ExecutionType": { "type": "enum", "members": { "LAMBDA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LAMBDA" } }, "RETURN_CONTROL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETURN_CONTROL" } } } }, "com.amazonaws.bedrockagentruntime#ExternalSource": { "type": "structure", "members": { "sourceType": { "target": "com.amazonaws.bedrockagentruntime#ExternalSourceType", "traits": { "smithy.api#documentation": "The source type of the external source wrapper object.
", "smithy.api#required": {} } }, "s3Location": { "target": "com.amazonaws.bedrockagentruntime#S3ObjectDoc", "traits": { "smithy.api#documentation": "The S3 location of the external source wrapper object.
" } }, "byteContent": { "target": "com.amazonaws.bedrockagentruntime#ByteContentDoc", "traits": { "smithy.api#documentation": "The identifier, contentType, and data of the external source wrapper object.
" } } }, "traits": { "smithy.api#documentation": "The unique external source of the content contained in the wrapper object.
" } }, "com.amazonaws.bedrockagentruntime#ExternalSourceType": { "type": "enum", "members": { "S3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3" } }, "BYTE_CONTENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BYTE_CONTENT" } } } }, "com.amazonaws.bedrockagentruntime#ExternalSources": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#ExternalSource" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.bedrockagentruntime#ExternalSourcesGenerationConfiguration": { "type": "structure", "members": { "promptTemplate": { "target": "com.amazonaws.bedrockagentruntime#PromptTemplate", "traits": { "smithy.api#documentation": "Contain the textPromptTemplate string for the external source wrapper object.
" } }, "guardrailConfiguration": { "target": "com.amazonaws.bedrockagentruntime#GuardrailConfiguration", "traits": { "smithy.api#documentation": "The configuration details for the guardrail.
" } }, "inferenceConfig": { "target": "com.amazonaws.bedrockagentruntime#InferenceConfig", "traits": { "smithy.api#documentation": "Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
" } }, "additionalModelRequestFields": { "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", "traits": { "smithy.api#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.
" } }, "performanceConfig": { "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", "traits": { "smithy.api#documentation": "The latency configuration for the model.
" } } }, "traits": { "smithy.api#documentation": "Contains the generation configuration of the external source wrapper object.
" } }, "com.amazonaws.bedrockagentruntime#ExternalSourcesRetrieveAndGenerateConfiguration": { "type": "structure", "members": { "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { "smithy.api#documentation": "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 prompt used with the external source wrapper object with the retrieveAndGenerate function.
The configurations of the external source wrapper object in the retrieveAndGenerate function.
The unique identifier of the trace.
" } }, "failureReason": { "target": "com.amazonaws.bedrockagentruntime#FailureReasonString", "traits": { "smithy.api#documentation": "The reason the interaction failed.
" } }, "failureCode": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The failure code for the trace.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Information about the failure that occurred.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the failure of the interaction.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FieldForReranking": { "type": "structure", "members": { "fieldName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of a metadata field to include in or exclude from consideration when reranking.
", "smithy.api#length": { "min": 1, "max": 2000 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information for a metadata field to include in or exclude from consideration when reranking.
" } }, "com.amazonaws.bedrockagentruntime#FieldsForReranking": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#FieldForReranking" }, "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FileBody": { "type": "blob", "traits": { "smithy.api#length": { "max": 1000000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FilePart": { "type": "structure", "members": { "files": { "target": "com.amazonaws.bedrockagentruntime#OutputFiles", "traits": { "smithy.api#documentation": "Files containing intermediate response for the user.
" } } }, "traits": { "smithy.api#documentation": "Contains intermediate response for code interpreter if any files have been generated.
" } }, "com.amazonaws.bedrockagentruntime#FileSource": { "type": "structure", "members": { "sourceType": { "target": "com.amazonaws.bedrockagentruntime#FileSourceType", "traits": { "smithy.api#documentation": "The source type of the files to attach.
", "smithy.api#required": {} } }, "s3Location": { "target": "com.amazonaws.bedrockagentruntime#S3ObjectFile", "traits": { "smithy.api#documentation": "The s3 location of the files to attach.
" } }, "byteContent": { "target": "com.amazonaws.bedrockagentruntime#ByteContentFile", "traits": { "smithy.api#documentation": "The data and the text of the attached files.
" } } }, "traits": { "smithy.api#documentation": "The source file of the content contained in the wrapper object.
" } }, "com.amazonaws.bedrockagentruntime#FileSourceType": { "type": "enum", "members": { "S3": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3" } }, "BYTE_CONTENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BYTE_CONTENT" } } } }, "com.amazonaws.bedrockagentruntime#FileUseCase": { "type": "enum", "members": { "CODE_INTERPRETER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CODE_INTERPRETER" } }, "CHAT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHAT" } } } }, "com.amazonaws.bedrockagentruntime#Files": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.bedrockagentruntime#FilterAttribute": { "type": "structure", "members": { "key": { "target": "com.amazonaws.bedrockagentruntime#FilterKey", "traits": { "smithy.api#documentation": "The name that the metadata attribute must match.
", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.bedrockagentruntime#FilterValue", "traits": { "smithy.api#documentation": "The value to which to compare the value of the metadata attribute.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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:
" } }, "com.amazonaws.bedrockagentruntime#FilterKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.bedrockagentruntime#FilterValue": { "type": "document" }, "com.amazonaws.bedrockagentruntime#FinalResponse": { "type": "structure", "members": { "text": { "target": "com.amazonaws.bedrockagentruntime#FinalResponseString", "traits": { "smithy.api#documentation": "The text in the response to the user.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Contains information about the invoke agent operation.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the response to the user.
" } }, "com.amazonaws.bedrockagentruntime#FinalResponseString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#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]+)$" } }, "com.amazonaws.bedrockagentruntime#FlowCompletionEvent": { "type": "structure", "members": { "completionReason": { "target": "com.amazonaws.bedrockagentruntime#FlowCompletionReason", "traits": { "smithy.api#documentation": "The reason that the flow completed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about why a flow completed.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowCompletionReason": { "type": "enum", "members": { "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESS" } }, "INPUT_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INPUT_REQUIRED" } } } }, "com.amazonaws.bedrockagentruntime#FlowControlNodeType": { "type": "enum", "members": { "ITERATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Iterator" } }, "LOOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Loop" } } } }, "com.amazonaws.bedrockagentruntime#FlowErrorCode": { "type": "enum", "members": { "VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION" } }, "INTERNAL_SERVER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_SERVER" } }, "NODE_EXECUTION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NODE_EXECUTION_FAILED" } } } }, "com.amazonaws.bedrockagentruntime#FlowExecutionContent": { "type": "union", "members": { "document": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The document content of the field, which can contain text or structured data.
" } } }, "traits": { "smithy.api#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 name of the node in the flow where the error occurred (if applicable).
" } }, "error": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionErrorType", "traits": { "smithy.api#documentation": "The error code for the type of error that occurred.
" } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A descriptive message that provides details about the error.
" } } }, "traits": { "smithy.api#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 the inputs provided to the flow at the start of execution.
" } }, "flowOutputEvent": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionOutputEvent", "traits": { "smithy.api#documentation": "Contains information about the outputs produced by the flow at the end of execution.
" } }, "nodeInputEvent": { "target": "com.amazonaws.bedrockagentruntime#NodeInputEvent", "traits": { "smithy.api#documentation": "Contains information about the inputs provided to a specific node during execution.
" } }, "nodeOutputEvent": { "target": "com.amazonaws.bedrockagentruntime#NodeOutputEvent", "traits": { "smithy.api#documentation": "Contains information about the outputs produced by a specific node during execution.
" } }, "conditionResultEvent": { "target": "com.amazonaws.bedrockagentruntime#ConditionResultEvent", "traits": { "smithy.api#documentation": "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.
" } }, "nodeFailureEvent": { "target": "com.amazonaws.bedrockagentruntime#NodeFailureEvent", "traits": { "smithy.api#documentation": "Contains information about a failure that occurred at a specific node during execution.
" } }, "flowFailureEvent": { "target": "com.amazonaws.bedrockagentruntime#FlowFailureEvent", "traits": { "smithy.api#documentation": "Contains information about a failure that occurred at the flow level during execution.
" } }, "nodeActionEvent": { "target": "com.amazonaws.bedrockagentruntime#NodeActionEvent", "traits": { "smithy.api#documentation": "Contains information about an action (operation) called by a node during execution.
" } }, "nodeDependencyEvent": { "target": "com.amazonaws.bedrockagentruntime#NodeDependencyEvent", "traits": { "smithy.api#documentation": "Contains information about an internal trace of a specific node during execution.
" } } }, "traits": { "smithy.api#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.
The name of the node that receives the inputs.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the inputs are provided.
", "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.bedrockagentruntime#FlowInputFields", "traits": { "smithy.api#documentation": "A list of input fields provided to the flow.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
The name of the node that produces the outputs.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the outputs are produced.
", "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.bedrockagentruntime#FlowOutputFields", "traits": { "smithy.api#documentation": "A list of output fields produced by the flow.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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 Amazon Resource Name (ARN) that uniquely identifies the flow execution.
", "smithy.api#required": {} } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", "smithy.api#required": {} } }, "flowIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow.
", "smithy.api#required": {} } }, "flowVersion": { "target": "com.amazonaws.bedrockagentruntime#Version", "traits": { "smithy.api#documentation": "The version of the flow used for the execution.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionStatus", "traits": { "smithy.api#documentation": "The current status of the flow execution.
Flow executions time out after 24 hours.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the flow execution was created.
", "smithy.api#required": {} } }, "endedAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
" } } }, "traits": { "smithy.api#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 timestamp when the failure occurred.
", "smithy.api#required": {} } }, "errorCode": { "target": "com.amazonaws.bedrockagentruntime#FlowErrorCode", "traits": { "smithy.api#documentation": "The error code that identifies the type of failure that occurred.
", "smithy.api#required": {} } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A descriptive message that provides details about the failure.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
The name of the flow input node that begins the prompt flow.
", "smithy.api#required": {} } }, "nodeOutputName": { "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", "traits": { "smithy.api#documentation": "The name of the output from the flow input node that begins the prompt flow.
" } }, "content": { "target": "com.amazonaws.bedrockagentruntime#FlowInputContent", "traits": { "smithy.api#documentation": "Contains information about an input into the prompt flow.
", "smithy.api#required": {} } }, "nodeInputName": { "target": "com.amazonaws.bedrockagentruntime#NodeInputName", "traits": { "smithy.api#documentation": "The name of the input from the flow input node.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an input into the prompt flow and where to send it.
" } }, "com.amazonaws.bedrockagentruntime#FlowInputContent": { "type": "union", "members": { "document": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The input to send to the prompt flow input node.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an input into the flow.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowInputField": { "type": "structure", "members": { "name": { "target": "com.amazonaws.bedrockagentruntime#NodeInputName", "traits": { "smithy.api#documentation": "The name of the input field as defined in the flow's input schema.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionContent", "traits": { "smithy.api#documentation": "The content of the input field, which can contain text or structured data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#documentation": "The content structure containing input information for multi-turn flow interactions.
" } }, "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputRequestEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the node in the flow that is requesting the input.
", "smithy.api#required": {} } }, "nodeType": { "target": "com.amazonaws.bedrockagentruntime#NodeType", "traits": { "smithy.api#documentation": "The type of the node in the flow that is requesting the input.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputContent", "traits": { "smithy.api#documentation": "The content payload containing the input request details for the multi-turn interaction.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Response object from the flow multi-turn node requesting additional information.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowNodeIODataType": { "type": "enum", "members": { "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "String" } }, "NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Number" } }, "BOOLEAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Boolean" } }, "OBJECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Object" } }, "ARRAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Array" } } } }, "com.amazonaws.bedrockagentruntime#FlowNodeInputCategory": { "type": "enum", "members": { "LOOP_CONDITION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LoopCondition" } }, "RETURN_VALUE_TO_LOOP_START": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReturnValueToLoopStart" } }, "EXIT_LOOP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ExitLoop" } } } }, "com.amazonaws.bedrockagentruntime#FlowNodeInputExpression": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowNodeInputName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" } }, "com.amazonaws.bedrockagentruntime#FlowNodeOutputName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$" } }, "com.amazonaws.bedrockagentruntime#FlowOutputContent": { "type": "union", "members": { "document": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The content in the output.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the content in an output from prompt flow invocation.
" } }, "com.amazonaws.bedrockagentruntime#FlowOutputEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the flow output node that the output is from.
", "smithy.api#required": {} } }, "nodeType": { "target": "com.amazonaws.bedrockagentruntime#NodeType", "traits": { "smithy.api#documentation": "The type of the node that the output is from.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.bedrockagentruntime#FlowOutputContent", "traits": { "smithy.api#documentation": "The content in the output.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about an output from prompt flow invoction.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowOutputField": { "type": "structure", "members": { "name": { "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", "traits": { "smithy.api#documentation": "The name of the output field as defined in the flow's output schema.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionContent", "traits": { "smithy.api#documentation": "The content of the output field, which can contain text or structured data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
Contains information about an output from flow invocation.
" } }, "flowCompletionEvent": { "target": "com.amazonaws.bedrockagentruntime#FlowCompletionEvent", "traits": { "smithy.api#documentation": "Contains information about why the flow completed.
" } }, "flowTraceEvent": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceEvent", "traits": { "smithy.api#documentation": "Contains information about a trace, which tracks an input or output for a node in the flow.
" } }, "internalServerException": { "target": "com.amazonaws.bedrockagentruntime#InternalServerException", "traits": { "smithy.api#documentation": "An internal server error occurred. Retry your request.
" } }, "validationException": { "target": "com.amazonaws.bedrockagentruntime#ValidationException", "traits": { "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" } }, "resourceNotFoundException": { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", "traits": { "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" } }, "serviceQuotaExceededException": { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", "traits": { "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
" } }, "throttlingException": { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", "traits": { "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
" } }, "accessDeniedException": { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", "traits": { "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
" } }, "conflictException": { "target": "com.amazonaws.bedrockagentruntime#ConflictException", "traits": { "smithy.api#documentation": "There was a conflict performing an operation. Resolve the conflict and retry your request.
" } }, "dependencyFailedException": { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", "traits": { "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
" } }, "badGatewayException": { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", "traits": { "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
" } }, "flowMultiTurnInputRequestEvent": { "target": "com.amazonaws.bedrockagentruntime#FlowMultiTurnInputRequestEvent", "traits": { "smithy.api#documentation": "The event stream containing the multi-turn input request information from the flow.
" } } }, "traits": { "smithy.api#documentation": "The output of the flow.
", "smithy.api#streaming": {} } }, "com.amazonaws.bedrockagentruntime#FlowTrace": { "type": "union", "members": { "nodeInputTrace": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputEvent", "traits": { "smithy.api#documentation": "Contains information about the input into a node.
" } }, "nodeOutputTrace": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputEvent", "traits": { "smithy.api#documentation": "Contains information about the output from a node.
" } }, "conditionNodeResultTrace": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceConditionNodeResultEvent", "traits": { "smithy.api#documentation": "Contains information about an output from a condition node.
" } }, "nodeActionTrace": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeActionEvent", "traits": { "smithy.api#documentation": "Contains information about an action (operation) called by a node.
" } }, "nodeDependencyTrace": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceDependencyEvent", "traits": { "smithy.api#documentation": "Contains information about an internal trace of a node.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceCondition": { "type": "structure", "members": { "conditionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the condition.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceConditionNodeResultEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the condition node.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The date and time that the trace was returned.
", "smithy.api#required": {} } }, "satisfiedConditions": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceConditions", "traits": { "smithy.api#documentation": "An array of objects containing information about the conditions that were satisfied.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceConditions": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceCondition" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.bedrockagentruntime#FlowTraceDependencyEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the node that generated the dependency trace.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The date and time that the dependency trace was generated.
", "smithy.api#required": {} } }, "traceElements": { "target": "com.amazonaws.bedrockagentruntime#TraceElements", "traits": { "smithy.api#documentation": "The trace elements containing detailed information about the dependency.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about a dependency trace event in the flow.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceEvent": { "type": "structure", "members": { "trace": { "target": "com.amazonaws.bedrockagentruntime#FlowTrace", "traits": { "smithy.api#documentation": "The trace object containing information about an input or output for a node in the flow.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
" } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeActionEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the node that called the operation.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The date and time that the operation was called.
", "smithy.api#required": {} } }, "requestId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the request that the node made to the operation.
", "smithy.api#required": {} } }, "serviceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the service that the node called.
", "smithy.api#required": {} } }, "operationName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the operation that the node called.
", "smithy.api#required": {} } }, "operationRequest": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The request payload sent to the downstream service.
" } }, "operationResponse": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The response payload received from the downstream service.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputContent": { "type": "union", "members": { "document": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The content of the node input.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the node that received the input.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The date and time that the trace was returned.
", "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputFields", "traits": { "smithy.api#documentation": "An array of objects containing information about each field in the input.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChain": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChainItem" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChainItem": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the node in the execution chain.
", "smithy.api#required": {} } }, "index": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The index position of this item in the execution chain.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#FlowControlNodeType", "traits": { "smithy.api#documentation": "The type of execution chain item. Supported values are Iterator and Loop.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents an item in the execution chain for flow trace node input tracking.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputField": { "type": "structure", "members": { "nodeInputName": { "target": "com.amazonaws.bedrockagentruntime#NodeInputName", "traits": { "smithy.api#documentation": "The name of the node input.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputContent", "traits": { "smithy.api#documentation": "The content of the node input.
", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputSource", "traits": { "smithy.api#documentation": "The source node that provides input data to this field.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", "traits": { "smithy.api#documentation": "The data type of the input field for compatibility validation.
" } }, "category": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputCategory", "traits": { "smithy.api#documentation": "The category of the input field.
" } }, "executionChain": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputExecutionChain", "traits": { "smithy.api#documentation": "The execution path through nested nodes like iterators and loops.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputFields": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputField" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeInputSource": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the source node that provides the input data.
", "smithy.api#required": {} } }, "outputFieldName": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeOutputName", "traits": { "smithy.api#documentation": "The name of the output field from the source node.
", "smithy.api#required": {} } }, "expression": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputExpression", "traits": { "smithy.api#documentation": "The expression used to extract data from the source.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the source of input data for a flow trace node field.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputContent": { "type": "union", "members": { "document": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The content of the node output.
" } } }, "traits": { "smithy.api#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.
" } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the node that yielded the output.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The date and time that the trace was returned.
", "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputFields", "traits": { "smithy.api#documentation": "An array of objects containing information about each field in the output.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputField": { "type": "structure", "members": { "nodeOutputName": { "target": "com.amazonaws.bedrockagentruntime#NodeOutputName", "traits": { "smithy.api#documentation": "The name of the node output.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputContent", "traits": { "smithy.api#documentation": "The content of the node output.
", "smithy.api#required": {} } }, "next": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNextList", "traits": { "smithy.api#documentation": "The next node that receives output data from this field.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", "traits": { "smithy.api#documentation": "The data type of the output field for compatibility validation.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputFields": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputField" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNext": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the next node that receives the output data.
", "smithy.api#required": {} } }, "inputFieldName": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputName", "traits": { "smithy.api#documentation": "The name of the input field in the next node that receives the data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the next node that receives output data from a flow trace.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNextList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#FlowTraceNodeOutputNext" } }, "com.amazonaws.bedrockagentruntime#FoundationModelConfiguration": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#FoundationModelConfigurationType", "traits": { "smithy.api#documentation": "The type of foundation model configuration.
", "smithy.api#required": {} } }, "bedrockFoundationModelConfiguration": { "target": "com.amazonaws.bedrockagentruntime#BedrockFoundationModelConfiguration", "traits": { "smithy.api#documentation": "The Bedrock foundation model configuration.
" } }, "mantleFoundationModelConfiguration": { "target": "com.amazonaws.bedrockagentruntime#MantleFoundationModelConfiguration", "traits": { "smithy.api#documentation": "The Mantle foundation model configuration.
" } } }, "traits": { "smithy.api#documentation": "Configuration for the foundation model.
" } }, "com.amazonaws.bedrockagentruntime#FoundationModelConfigurationType": { "type": "enum", "members": { "BEDROCK_FOUNDATION_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEDROCK_FOUNDATION_MODEL" } }, "MANTLE_FOUNDATION_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANTLE_FOUNDATION_MODEL" } } }, "traits": { "smithy.api#documentation": "The type of foundation model configuration.
" } }, "com.amazonaws.bedrockagentruntime#FoundationModelType": { "type": "enum", "members": { "CUSTOM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM" } }, "MANAGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGED" } } }, "traits": { "smithy.api#documentation": "The type of foundation model.
" } }, "com.amazonaws.bedrockagentruntime#Function": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#FunctionDefinition": { "type": "structure", "members": { "name": { "target": "com.amazonaws.bedrockagentruntime#ResourceName", "traits": { "smithy.api#documentation": "A name for the function.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentruntime#FunctionDescription", "traits": { "smithy.api#documentation": "A description of the function and its purpose.
" } }, "parameters": { "target": "com.amazonaws.bedrockagentruntime#ParameterMap", "traits": { "smithy.api#documentation": "The parameters that the agent elicits from the user to fulfill the function.
" } }, "requireConfirmation": { "target": "com.amazonaws.bedrockagentruntime#RequireConfirmation", "traits": { "smithy.api#documentation": "Contains information if user confirmation is required to invoke the function.
" } } }, "traits": { "smithy.api#documentation": "Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
" } }, "com.amazonaws.bedrockagentruntime#FunctionDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1200 } } }, "com.amazonaws.bedrockagentruntime#FunctionInvocationInput": { "type": "structure", "members": { "actionGroup": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The action group that the function belongs to.
", "smithy.api#required": {} } }, "parameters": { "target": "com.amazonaws.bedrockagentruntime#FunctionParameters", "traits": { "smithy.api#documentation": "A list of parameters of the function.
" } }, "function": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the function.
" } }, "actionInvocationType": { "target": "com.amazonaws.bedrockagentruntime#ActionInvocationType", "traits": { "smithy.api#documentation": "Contains information about the function to invoke,
" } }, "agentId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The agent's ID.
" } }, "collaboratorName": { "target": "com.amazonaws.bedrockagentruntime#Name", "traits": { "smithy.api#documentation": "The collaborator's name.
" } } }, "traits": { "smithy.api#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": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The data type of the parameter.
" } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The value of the parameter.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#required": {} } }, "confirmationState": { "target": "com.amazonaws.bedrockagentruntime#ConfirmationState", "traits": { "smithy.api#documentation": "Contains the user confirmation information about the function that was called.
" } }, "function": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the function that was called.
" } }, "responseBody": { "target": "com.amazonaws.bedrockagentruntime#ResponseBody", "traits": { "smithy.api#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
" } }, "agentId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The agent's ID.
" } } }, "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
" } }, "com.amazonaws.bedrockagentruntime#Functions": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#FunctionDefinition" } }, "com.amazonaws.bedrockagentruntime#GenerateQuery": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#GenerateQueryRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#GenerateQueryResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#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.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/generateQuery" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#GenerateQueryRequest": { "type": "structure", "members": { "queryGenerationInput": { "target": "com.amazonaws.bedrockagentruntime#QueryGenerationInput", "traits": { "smithy.api#documentation": "Specifies information about a natural language query to transform into SQL.
", "smithy.api#required": {} } }, "transformationConfiguration": { "target": "com.amazonaws.bedrockagentruntime#TransformationConfiguration", "traits": { "smithy.api#documentation": "Specifies configurations for transforming the natural language query into SQL.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#GenerateQueryResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#GenerateQuery" } ] }, "com.amazonaws.bedrockagentruntime#GenerateQueryResponse": { "type": "structure", "members": { "queries": { "target": "com.amazonaws.bedrockagentruntime#GeneratedQueries", "traits": { "smithy.api#documentation": "A list of objects, each of which defines a generated query that can correspond to the natural language queries.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#GeneratedQueries": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#GeneratedQuery" }, "traits": { "smithy.api#length": { "min": 0 } } }, "com.amazonaws.bedrockagentruntime#GeneratedQuery": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#GeneratedQueryType", "traits": { "smithy.api#documentation": "The type of transformed query.
" } }, "sql": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An SQL query that corresponds to the natural language query.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a query generated for a natural language query.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GeneratedQueryType": { "type": "enum", "members": { "REDSHIFT_SQL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REDSHIFT_SQL" } } } }, "com.amazonaws.bedrockagentruntime#GeneratedResponsePart": { "type": "structure", "members": { "textResponsePart": { "target": "com.amazonaws.bedrockagentruntime#TextResponsePart", "traits": { "smithy.api#documentation": "Contains metadata about a textual part of the generated response that is accompanied by a citation.
" } } }, "traits": { "smithy.api#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 \u2013 in the generatedResponsePart field
RetrieveAndGenerate response \u2013 in the generatedResponsePart field
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.
The configuration details for the guardrail.
" } }, "inferenceConfig": { "target": "com.amazonaws.bedrockagentruntime#InferenceConfig", "traits": { "smithy.api#documentation": "Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
" } }, "additionalModelRequestFields": { "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", "traits": { "smithy.api#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.
" } }, "performanceConfig": { "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", "traits": { "smithy.api#documentation": "The latency configuration for the model.
" } } }, "traits": { "smithy.api#documentation": "Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
" } }, "com.amazonaws.bedrockagentruntime#GetAgentMemory": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#GetAgentMemoryRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#GetAgentMemoryResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Gets the sessions stored in the memory of the agent.
", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/agents/{agentId}/agentAliases/{agentAliasId}/memories" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxItems", "items": "memoryContents" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#GetAgentMemoryRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#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.
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 agent to which the alias belongs.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "agentAliasId": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", "traits": { "smithy.api#documentation": "The unique identifier of an alias of an agent.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "memoryType": { "target": "com.amazonaws.bedrockagentruntime#MemoryType", "traits": { "smithy.api#documentation": "The type of memory.
", "smithy.api#httpQuery": "memoryType", "smithy.api#required": {} } }, "memoryId": { "target": "com.amazonaws.bedrockagentruntime#MemoryId", "traits": { "smithy.api#documentation": "The unique identifier of the memory.
", "smithy.api#httpQuery": "memoryId", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#GetAgentMemoryResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#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.
Contains details of the sessions stored in the memory
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#GetDocumentContent": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#GetDocumentContentRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#GetDocumentContentResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the content of an ingested document from a knowledge base, or of an image embedded in the document. Returns a pre-signed URL for downloading the content. Use this operation to display the source of a Retrieve result.
The unique identifier of the knowledge base that contains the document.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagentruntime#DataSourceId", "traits": { "smithy.api#documentation": "The unique identifier of the data source that contains the document.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "documentId": { "target": "com.amazonaws.bedrockagentruntime#DocumentId", "traits": { "smithy.api#documentation": "The unique identifier of the document to retrieve content for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "mediaId": { "target": "com.amazonaws.bedrockagentruntime#MediaId", "traits": { "smithy.api#documentation": "The unique identifier (in UUID format) of an image embedded in the specified document. Set this parameter to the _media_id value in the metadata of the corresponding Retrieve result. If you specify this parameter, the response contains a pre-signed URL for the image instead of the document, and you must omit outputFormat or set it to RAW.
The output format for the content. You can specify one of the following values:
Returns the original document, or the selected image if you specify mediaId.
Returns parsed document text as JSON.
If you omit this parameter, the default is RAW. You can't use EXTRACTED with mediaId.
Contains information about the user making the request. This is used for access control filtering to ensure that results only include documents the user is authorized to access.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#GetDocumentContentResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#GetDocumentContent" } ] }, "com.amazonaws.bedrockagentruntime#GetDocumentContentResponse": { "type": "structure", "members": { "mimeType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The MIME type of the returned content. For RAW format, this is the original file type (for example, application/pdf), or the image type (for example, image/png) if you specify mediaId. For EXTRACTED format, this is always application/json.
A pre-signed URL for downloading the document content, or the selected image if you specify mediaId. The URL expires after 5 minutes.
The size, in bytes, of the content available at the pre-signed URL.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#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.
The unique identifier of the flow.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias used for the flow execution.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow execution.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#GetExecutionFlowSnapshotResponse": { "type": "structure", "members": { "flowIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow.
", "smithy.api#required": {} } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias used for the flow execution.
", "smithy.api#required": {} } }, "flowVersion": { "target": "com.amazonaws.bedrockagentruntime#Version", "traits": { "smithy.api#documentation": "The version of the flow used for the flow execution.
", "smithy.api#required": {} } }, "executionRoleArn": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution.
", "smithy.api#required": {} } }, "definition": { "target": "smithy.api#String", "traits": { "smithy.api#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.
", "smithy.api#required": {} } }, "customerEncryptionKeyArn": { "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customer managed KMS key that's used to encrypt the flow snapshot.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#GetFlowExecution": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#GetFlowExecutionRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#GetFlowExecutionResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/flows/{flowIdentifier}/aliases/{flowAliasIdentifier}/executions/{executionIdentifier}" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#GetFlowExecutionRequest": { "type": "structure", "members": { "flowIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow execution to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#GetFlowExecutionResponse": { "type": "structure", "members": { "executionArn": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionStatus", "traits": { "smithy.api#documentation": "The current status of the flow execution.
Flow executions time out after 24 hours.
", "smithy.api#required": {} } }, "startedAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the flow execution started.
", "smithy.api#required": {} } }, "endedAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#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": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionErrors", "traits": { "smithy.api#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.
" } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", "smithy.api#required": {} } }, "flowIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow.
", "smithy.api#required": {} } }, "flowVersion": { "target": "com.amazonaws.bedrockagentruntime#Version", "traits": { "smithy.api#documentation": "The version of the flow used for the execution.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#GetIngestedDocumentAcl": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#GetIngestedDocumentAclRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#GetIngestedDocumentAclResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the ingested access control list (ACL) for a specific document in a knowledge base. Use this operation to inspect the allow and deny lists that were ingested for a document to troubleshoot access control issues. To use this operation, you must have the bedrock:GetIngestedDocumentAcl permission.
The unique identifier of the knowledge base that contains the document.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagentruntime#DataSourceId", "traits": { "smithy.api#documentation": "The unique identifier of the data source that contains the document.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "documentId": { "target": "com.amazonaws.bedrockagentruntime#DocumentId", "traits": { "smithy.api#documentation": "The unique identifier of the document to retrieve the ingested access control list (ACL) for.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#GetIngestedDocumentAclResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#GetIngestedDocumentAcl" } ] }, "com.amazonaws.bedrockagentruntime#GetIngestedDocumentAclResponse": { "type": "structure", "members": { "documentAcl": { "target": "com.amazonaws.bedrockagentruntime#DocumentAcl", "traits": { "smithy.api#documentation": "The ingested document access control list (ACL) containing allow and deny membership information.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#GetInvocationStep": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#GetInvocationStepRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#GetInvocationStepResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#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.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/sessions/{sessionIdentifier}/invocationSteps/{invocationStepId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#GetInvocationStepRequest": { "type": "structure", "members": { "invocationIdentifier": { "target": "com.amazonaws.bedrockagentruntime#InvocationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier for the invocation in UUID format.
", "smithy.api#required": {} } }, "invocationStepId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier (in UUID format) for the specific invocation step to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "sessionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", "traits": { "smithy.api#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.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#GetSession": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#GetSessionRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#GetSessionResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/sessions/{sessionIdentifier}/" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#GetSessionRequest": { "type": "structure", "members": { "sessionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", "traits": { "smithy.api#documentation": "A unique identifier for the session to retrieve. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The unique identifier for the session in UUID format.
", "smithy.api#required": {} } }, "sessionArn": { "target": "com.amazonaws.bedrockagentruntime#SessionArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session.
", "smithy.api#required": {} } }, "sessionStatus": { "target": "com.amazonaws.bedrockagentruntime#SessionStatus", "traits": { "smithy.api#documentation": "The current status of the session.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the session was created.
", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the session was last modified.
", "smithy.api#required": {} } }, "sessionMetadata": { "target": "com.amazonaws.bedrockagentruntime#SessionMetadataMap", "traits": { "smithy.api#documentation": "A map of key-value pairs containing attributes persisted across the session.
" } }, "encryptionKeyArn": { "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#GuadrailAction": { "type": "enum", "members": { "INTERVENED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERVENED" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailAction": { "type": "enum", "members": { "INTERVENED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERVENED" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailAssessment": { "type": "structure", "members": { "topicPolicy": { "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAssessment", "traits": { "smithy.api#documentation": "Topic policy details of the Guardrail.
" } }, "contentPolicy": { "target": "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAssessment", "traits": { "smithy.api#documentation": "Content policy details of the Guardrail.
" } }, "wordPolicy": { "target": "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAssessment", "traits": { "smithy.api#documentation": "Word policy details of the Guardrail.
" } }, "sensitiveInformationPolicy": { "target": "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAssessment", "traits": { "smithy.api#documentation": "Sensitive Information policy details of Guardrail.
" } } }, "traits": { "smithy.api#documentation": "Assessment details of the content analyzed by Guardrails.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailAssessmentList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#GuardrailAssessment" } }, "com.amazonaws.bedrockagentruntime#GuardrailConfiguration": { "type": "structure", "members": { "guardrailId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier for the guardrail.
", "smithy.api#length": { "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+$", "smithy.api#required": {} } }, "guardrailVersion": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The version of the guardrail.
", "smithy.api#length": { "min": 1, "max": 5 }, "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The configuration details for the guardrail.
" } }, "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn": { "type": "structure", "members": { "guardrailIdentifier": { "target": "com.amazonaws.bedrockagentruntime#GuardrailIdentifierWithArn", "traits": { "smithy.api#documentation": "The unique identifier for the guardrail.
", "smithy.api#required": {} } }, "guardrailVersion": { "target": "com.amazonaws.bedrockagentruntime#GuardrailVersion", "traits": { "smithy.api#documentation": "The version of the guardrail.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The configuration details for the guardrail.
" } }, "com.amazonaws.bedrockagentruntime#GuardrailContentFilter": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilterType", "traits": { "smithy.api#documentation": "The type of content detected in the filter by the Guardrail.
" } }, "confidence": { "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilterConfidence", "traits": { "smithy.api#documentation": "The confidence level regarding the content detected in the filter by the Guardrail.
" } }, "action": { "target": "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAction", "traits": { "smithy.api#documentation": "The action placed on the content by the Guardrail filter.
" } } }, "traits": { "smithy.api#documentation": "Details of the content filter used in the Guardrail.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailContentFilterConfidence": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOW" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailContentFilterList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilter" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailContentFilterType": { "type": "enum", "members": { "INSULTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSULTS" } }, "HATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HATE" } }, "SEXUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SEXUAL" } }, "VIOLENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VIOLENCE" } }, "MISCONDUCT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISCONDUCT" } }, "PROMPT_ATTACK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROMPT_ATTACK" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAction": { "type": "enum", "members": { "BLOCKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BLOCKED" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailContentPolicyAssessment": { "type": "structure", "members": { "filters": { "target": "com.amazonaws.bedrockagentruntime#GuardrailContentFilterList", "traits": { "smithy.api#documentation": "The filter details of the policy assessment used in the Guardrails filter.
" } } }, "traits": { "smithy.api#documentation": "The details of the policy assessment in the Guardrails filter.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailCustomWord": { "type": "structure", "members": { "match": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The match details for the custom word filter in the Guardrail.
" } }, "action": { "target": "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction", "traits": { "smithy.api#documentation": "The action details for the custom word filter in the Guardrail.
" } } }, "traits": { "smithy.api#documentation": "The custom word details for the filter in the Guardrail.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailCustomWordList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#GuardrailCustomWord" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailEvent": { "type": "structure", "members": { "action": { "target": "com.amazonaws.bedrockagentruntime#GuadrailAction", "traits": { "smithy.api#documentation": "The guardrail action.
" } } }, "traits": { "smithy.api#documentation": "A guardrail event.
" } }, "com.amazonaws.bedrockagentruntime#GuardrailIdentifierWithArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$" } }, "com.amazonaws.bedrockagentruntime#GuardrailManagedWord": { "type": "structure", "members": { "match": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The match details for the managed word filter in the Guardrail.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#GuardrailManagedWordType", "traits": { "smithy.api#documentation": "The type details for the managed word filter in the Guardrail.
" } }, "action": { "target": "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction", "traits": { "smithy.api#documentation": "The action details for the managed word filter in the Guardrail.
" } } }, "traits": { "smithy.api#documentation": "The managed word details for the filter in the Guardrail.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailManagedWordList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#GuardrailManagedWord" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailManagedWordType": { "type": "enum", "members": { "PROFANITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROFANITY" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilter": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityType", "traits": { "smithy.api#documentation": "The type of PII the Guardrail filter has identified and removed.
" } }, "match": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The match to settings in the Guardrail filter to identify and remove PII.
" } }, "action": { "target": "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAction", "traits": { "smithy.api#documentation": "The action of the Guardrail filter to identify and remove PII.
" } } }, "traits": { "smithy.api#documentation": "The Guardrail filter to identify and remove personally identifiable information (PII).
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilterList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilter" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityType": { "type": "enum", "members": { "ADDRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADDRESS" } }, "AGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGE" } }, "AWS_ACCESS_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_ACCESS_KEY" } }, "AWS_SECRET_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_SECRET_KEY" } }, "CA_HEALTH_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CA_HEALTH_NUMBER" } }, "CA_SOCIAL_INSURANCE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CA_SOCIAL_INSURANCE_NUMBER" } }, "CREDIT_DEBIT_CARD_CVV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREDIT_DEBIT_CARD_CVV" } }, "CREDIT_DEBIT_CARD_EXPIRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREDIT_DEBIT_CARD_EXPIRY" } }, "CREDIT_DEBIT_CARD_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREDIT_DEBIT_CARD_NUMBER" } }, "DRIVER_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DRIVER_ID" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL" } }, "INTERNATIONAL_BANK_ACCOUNT_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNATIONAL_BANK_ACCOUNT_NUMBER" } }, "IP_ADDRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IP_ADDRESS" } }, "LICENSE_PLATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LICENSE_PLATE" } }, "MAC_ADDRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAC_ADDRESS" } }, "NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NAME" } }, "PASSWORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASSWORD" } }, "PHONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PHONE" } }, "PIN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PIN" } }, "SWIFT_CODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SWIFT_CODE" } }, "UK_NATIONAL_HEALTH_SERVICE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UK_NATIONAL_HEALTH_SERVICE_NUMBER" } }, "UK_NATIONAL_INSURANCE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UK_NATIONAL_INSURANCE_NUMBER" } }, "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" } }, "URL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "URL" } }, "USERNAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USERNAME" } }, "US_BANK_ACCOUNT_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "US_BANK_ACCOUNT_NUMBER" } }, "US_BANK_ROUTING_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "US_BANK_ROUTING_NUMBER" } }, "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" } }, "US_PASSPORT_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "US_PASSPORT_NUMBER" } }, "US_SOCIAL_SECURITY_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "US_SOCIAL_SECURITY_NUMBER" } }, "VEHICLE_IDENTIFICATION_NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VEHICLE_IDENTIFICATION_NUMBER" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailRegexFilter": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name details for the regex filter used in the Guardrail.
" } }, "regex": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The regex details for the regex filter used in the Guardrail.
" } }, "match": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The match details for the regex filter used in the Guardrail.
" } }, "action": { "target": "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAction", "traits": { "smithy.api#documentation": "The action details for the regex filter used in the Guardrail.
" } } }, "traits": { "smithy.api#documentation": "The details for the regex filter used in the Guardrail.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailRegexFilterList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#GuardrailRegexFilter" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAction": { "type": "enum", "members": { "BLOCKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BLOCKED" } }, "ANONYMIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANONYMIZED" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailSensitiveInformationPolicyAssessment": { "type": "structure", "members": { "piiEntities": { "target": "com.amazonaws.bedrockagentruntime#GuardrailPiiEntityFilterList", "traits": { "smithy.api#documentation": "The details of the PII entities used in the sensitive policy assessment for the Guardrail.
" } }, "regexes": { "target": "com.amazonaws.bedrockagentruntime#GuardrailRegexFilterList", "traits": { "smithy.api#documentation": "The details of the regexes used in the sensitive policy assessment for the Guardrail.
" } } }, "traits": { "smithy.api#documentation": "The details of the sensitive policy assessment used in the Guardrail.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailTopic": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name details on a specific topic in the Guardrail.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicType", "traits": { "smithy.api#documentation": "The type details on a specific topic in the Guardrail.
" } }, "action": { "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAction", "traits": { "smithy.api#documentation": "The action details on a specific topic in the Guardrail.
" } } }, "traits": { "smithy.api#documentation": "The details for a specific topic defined in the Guardrail.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailTopicList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#GuardrailTopic" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAction": { "type": "enum", "members": { "BLOCKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BLOCKED" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailTopicPolicyAssessment": { "type": "structure", "members": { "topics": { "target": "com.amazonaws.bedrockagentruntime#GuardrailTopicList", "traits": { "smithy.api#documentation": "The topic details of the policy assessment used in the Guardrail.
" } } }, "traits": { "smithy.api#documentation": "The details of the policy assessment used in the Guardrail.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailTopicType": { "type": "enum", "members": { "DENY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DENY" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailTrace": { "type": "structure", "members": { "action": { "target": "com.amazonaws.bedrockagentruntime#GuardrailAction", "traits": { "smithy.api#documentation": "The trace action details used with the Guardrail.
" } }, "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { "smithy.api#documentation": "The details of the trace Id used in the Guardrail Trace.
" } }, "inputAssessments": { "target": "com.amazonaws.bedrockagentruntime#GuardrailAssessmentList", "traits": { "smithy.api#documentation": "The details of the input assessments used in the Guardrail Trace.
" } }, "outputAssessments": { "target": "com.amazonaws.bedrockagentruntime#GuardrailAssessmentList", "traits": { "smithy.api#documentation": "The details of the output assessments used in the Guardrail Trace.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Contains information about the Guardrail output.
" } } }, "traits": { "smithy.api#documentation": "The trace details used in the Guardrail.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#GuardrailVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5 }, "smithy.api#pattern": "^(([1-9][0-9]{0,7})|(DRAFT))$" } }, "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAction": { "type": "enum", "members": { "BLOCKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BLOCKED" } } } }, "com.amazonaws.bedrockagentruntime#GuardrailWordPolicyAssessment": { "type": "structure", "members": { "customWords": { "target": "com.amazonaws.bedrockagentruntime#GuardrailCustomWordList", "traits": { "smithy.api#documentation": "The custom word details for words defined in the Guardrail filter.
" } }, "managedWordLists": { "target": "com.amazonaws.bedrockagentruntime#GuardrailManagedWordList", "traits": { "smithy.api#documentation": "The managed word lists for words defined in the Guardrail filter.
" } } }, "traits": { "smithy.api#documentation": "The assessment details for words defined in the Guardrail filter.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#Identifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ImageBlock": { "type": "structure", "members": { "format": { "target": "com.amazonaws.bedrockagentruntime#ImageFormat", "traits": { "smithy.api#documentation": "The format of the image.
", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.bedrockagentruntime#ImageSource", "traits": { "smithy.api#documentation": "The source for the image.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Image content for an invocation step.
" } }, "com.amazonaws.bedrockagentruntime#ImageFormat": { "type": "enum", "members": { "PNG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "png" } }, "JPEG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "jpeg" } }, "GIF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gif" } }, "WEBP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "webp" } } } }, "com.amazonaws.bedrockagentruntime#ImageInput": { "type": "structure", "members": { "format": { "target": "com.amazonaws.bedrockagentruntime#ImageInputFormat", "traits": { "smithy.api#documentation": "The type of image in the result.
", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.bedrockagentruntime#ImageInputSource", "traits": { "smithy.api#documentation": "The source of the image in the result.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
" } }, "com.amazonaws.bedrockagentruntime#ImageInputFormat": { "type": "enum", "members": { "PNG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "png" } }, "JPEG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "jpeg" } }, "GIF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "gif" } }, "WEBP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "webp" } } } }, "com.amazonaws.bedrockagentruntime#ImageInputSource": { "type": "union", "members": { "bytes": { "target": "smithy.api#Blob", "traits": { "smithy.api#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.
", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#documentation": "Details about the source of an input image in the result from a function in the action group invocation.
" } }, "com.amazonaws.bedrockagentruntime#ImageInputs": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#ImageInput" } }, "com.amazonaws.bedrockagentruntime#ImageSource": { "type": "union", "members": { "bytes": { "target": "smithy.api#Blob", "traits": { "smithy.api#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.
", "smithy.api#length": { "min": 1 } } }, "s3Location": { "target": "com.amazonaws.bedrockagentruntime#S3Location", "traits": { "smithy.api#documentation": "The path to the Amazon S3 bucket where the image is stored.
" } } }, "traits": { "smithy.api#documentation": "The source for an image.
" } }, "com.amazonaws.bedrockagentruntime#ImplicitFilterConfiguration": { "type": "structure", "members": { "metadataAttributes": { "target": "com.amazonaws.bedrockagentruntime#MetadataAttributeSchemaList", "traits": { "smithy.api#documentation": "Metadata that can be used in a filter.
", "smithy.api#required": {} } }, "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { "smithy.api#documentation": "The model that generates the filter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Settings for implicit filtering, where a model generates a metadata filter based on the prompt.
" } }, "com.amazonaws.bedrockagentruntime#InferenceConfig": { "type": "structure", "members": { "textInferenceConfig": { "target": "com.amazonaws.bedrockagentruntime#TextInferenceConfig", "traits": { "smithy.api#documentation": "Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.
" } } }, "traits": { "smithy.api#documentation": "The configuration for inference settings when generating responses using RetrieveAndGenerate.
" } }, "com.amazonaws.bedrockagentruntime#InferenceConfiguration": { "type": "structure", "members": { "temperature": { "target": "com.amazonaws.bedrockagentruntime#Temperature", "traits": { "smithy.api#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.
" } }, "topP": { "target": "com.amazonaws.bedrockagentruntime#TopP", "traits": { "smithy.api#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 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.
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.
The maximum number of tokens allowed in the generated response.
" } }, "stopSequences": { "target": "com.amazonaws.bedrockagentruntime#StopSequences", "traits": { "smithy.api#documentation": "A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
" } } }, "traits": { "smithy.api#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.
" } }, "com.amazonaws.bedrockagentruntime#InferenceResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#InvokeAgent" } ] }, "com.amazonaws.bedrockagentruntime#InlineAgentFilePart": { "type": "structure", "members": { "files": { "target": "com.amazonaws.bedrockagentruntime#OutputFiles", "traits": { "smithy.api#documentation": "Files containing intermediate response for the user.
" } } }, "traits": { "smithy.api#documentation": "Contains intermediate response for code interpreter if any files have been generated.
" } }, "com.amazonaws.bedrockagentruntime#InlineAgentPayloadPart": { "type": "structure", "members": { "bytes": { "target": "com.amazonaws.bedrockagentruntime#PartBody", "traits": { "smithy.api#documentation": "A part of the agent response in bytes.
" } }, "attribution": { "target": "com.amazonaws.bedrockagentruntime#Attribution", "traits": { "smithy.api#documentation": "Contains citations for a part of an agent response.
" } } }, "traits": { "smithy.api#documentation": "Contains a part of an agent response and citations for it.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#InlineAgentResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#InvokeInlineAgent" } ] }, "com.amazonaws.bedrockagentruntime#InlineAgentResponseStream": { "type": "union", "members": { "chunk": { "target": "com.amazonaws.bedrockagentruntime#InlineAgentPayloadPart", "traits": { "smithy.api#documentation": "Contains a part of an agent response and citations for it.
" } }, "trace": { "target": "com.amazonaws.bedrockagentruntime#InlineAgentTracePart", "traits": { "smithy.api#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.
" } }, "returnControl": { "target": "com.amazonaws.bedrockagentruntime#InlineAgentReturnControlPayload", "traits": { "smithy.api#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.
" } }, "internalServerException": { "target": "com.amazonaws.bedrockagentruntime#InternalServerException", "traits": { "smithy.api#documentation": "An internal server error occurred. Retry your request.
" } }, "validationException": { "target": "com.amazonaws.bedrockagentruntime#ValidationException", "traits": { "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" } }, "resourceNotFoundException": { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", "traits": { "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" } }, "serviceQuotaExceededException": { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", "traits": { "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
" } }, "throttlingException": { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", "traits": { "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
" } }, "accessDeniedException": { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", "traits": { "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
" } }, "conflictException": { "target": "com.amazonaws.bedrockagentruntime#ConflictException", "traits": { "smithy.api#documentation": "There was a conflict performing an operation. Resolve the conflict and retry your request.
" } }, "dependencyFailedException": { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", "traits": { "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
" } }, "badGatewayException": { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", "traits": { "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
" } }, "files": { "target": "com.amazonaws.bedrockagentruntime#InlineAgentFilePart", "traits": { "smithy.api#documentation": "Contains intermediate response for code interpreter if any files have been generated.
" } } }, "traits": { "smithy.api#documentation": "The response from invoking the agent and associated citations and trace information.
", "smithy.api#streaming": {} } }, "com.amazonaws.bedrockagentruntime#InlineAgentReturnControlPayload": { "type": "structure", "members": { "invocationInputs": { "target": "com.amazonaws.bedrockagentruntime#InvocationInputs", "traits": { "smithy.api#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.
" } }, "invocationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the action group invocation.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#InlineAgentTracePart": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#documentation": "The unique identifier of the session with the agent.
" } }, "trace": { "target": "com.amazonaws.bedrockagentruntime#Trace", "traits": { "smithy.api#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.
" } }, "callerChain": { "target": "com.amazonaws.bedrockagentruntime#CallerChain", "traits": { "smithy.api#documentation": "The caller chain for the trace part.
" } }, "eventTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The time that trace occurred.
", "smithy.api#timestampFormat": "date-time" } }, "collaboratorName": { "target": "com.amazonaws.bedrockagentruntime#Name", "traits": { "smithy.api#documentation": "The collaborator name for the trace part.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#InlineBedrockModelConfigurations": { "type": "structure", "members": { "performanceConfig": { "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", "traits": { "smithy.api#documentation": "The latency configuration for the model.
" } } }, "traits": { "smithy.api#documentation": "Settings for a model called with InvokeInlineAgent.
" } }, "com.amazonaws.bedrockagentruntime#InlineSessionState": { "type": "structure", "members": { "sessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#SessionAttributesMap", "traits": { "smithy.api#documentation": "Contains attributes that persist across a session and the values of those attributes.
" } }, "promptSessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap", "traits": { "smithy.api#documentation": "Contains attributes that persist across a session and the values of those attributes.
" } }, "returnControlInvocationResults": { "target": "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults", "traits": { "smithy.api#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.
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 information about the files used by code interpreter.
" } }, "conversationHistory": { "target": "com.amazonaws.bedrockagentruntime#ConversationHistory", "traits": { "smithy.api#documentation": "Contains the conversation history that persist across sessions.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.bedrockagentruntime#FileSource", "traits": { "smithy.api#documentation": "Specifies where the files are located.
", "smithy.api#required": {} } }, "useCase": { "target": "com.amazonaws.bedrockagentruntime#FileUseCase", "traits": { "smithy.api#documentation": "Specifies how the source files will be used by the code interpreter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains details of the source files.
" } }, "com.amazonaws.bedrockagentruntime#InputFiles": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#InputFile" } }, "com.amazonaws.bedrockagentruntime#InputImage": { "type": "structure", "members": { "format": { "target": "com.amazonaws.bedrockagentruntime#InputImageFormat", "traits": { "smithy.api#documentation": "The format of the input image. Supported formats include png, gif, jpeg, and webp.
", "smithy.api#required": {} } }, "inlineContent": { "target": "com.amazonaws.bedrockagentruntime#ByteContentBlob", "traits": { "smithy.api#documentation": "The base64-encoded image data for inline image content. Maximum size is 5MB.
", "smithy.api#length": { "min": 1, "max": 5242880 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#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 \u2013 in the image field
Contains information about the text prompt to optimize.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the prompt to optimize.
" } }, "com.amazonaws.bedrockagentruntime#InputQueryType": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEXT" } } } }, "com.amazonaws.bedrockagentruntime#InputText": { "type": "string", "traits": { "smithy.api#length": { "max": 25000000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#Instruction": { "type": "string", "traits": { "smithy.api#length": { "min": 40 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.bedrockagentruntime#NonBlankString" }, "reason": { "target": "smithy.api#String", "traits": { "smithy.api#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.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.bedrockagentruntime#InvocationDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.bedrockagentruntime#InvocationIdentifier": { "type": "string", "traits": { "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, "com.amazonaws.bedrockagentruntime#InvocationInput": { "type": "structure", "members": { "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { "smithy.api#documentation": "The unique identifier of the trace.
" } }, "invocationType": { "target": "com.amazonaws.bedrockagentruntime#InvocationType", "traits": { "smithy.api#documentation": "Specifies whether the agent is invoking an action group or a knowledge base.
" } }, "actionGroupInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#ActionGroupInvocationInput", "traits": { "smithy.api#documentation": "Contains information about the action group to be invoked.
" } }, "knowledgeBaseLookupInput": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput", "traits": { "smithy.api#documentation": "Contains details about the knowledge base to look up and the query to be made.
" } }, "codeInterpreterInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationInput", "traits": { "smithy.api#documentation": "Contains information about the code interpreter to be invoked.
" } }, "agentCollaboratorInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationInput", "traits": { "smithy.api#documentation": "The collaborator's invocation input.
" } } }, "traits": { "smithy.api#documentation": "Contains information pertaining to the action group or knowledge base that is being invoked.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#InvocationInputMember": { "type": "union", "members": { "apiInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#ApiInvocationInput", "traits": { "smithy.api#documentation": "Contains information about the API operation that the agent predicts should be called.
" } }, "functionInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#FunctionInvocationInput", "traits": { "smithy.api#documentation": "Contains information about the function that the agent predicts should be called.
" } } }, "traits": { "smithy.api#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": { "target": "com.amazonaws.bedrockagentruntime#FunctionResult", "traits": { "smithy.api#documentation": "The result from the function from the action group invocation.
" } } }, "traits": { "smithy.api#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:
" } }, "com.amazonaws.bedrockagentruntime#InvocationStep": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier of the session containing the invocation step.
", "smithy.api#required": {} } }, "invocationId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier (in UUID format) for the invocation that includes the invocation step.
", "smithy.api#required": {} } }, "invocationStepId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier (in UUID format) for the invocation step.
", "smithy.api#required": {} } }, "invocationStepTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the invocation step was created.
", "smithy.api#required": {} } }, "payload": { "target": "com.amazonaws.bedrockagentruntime#InvocationStepPayload", "traits": { "smithy.api#documentation": "Payload content, such as text and images, for the invocation step.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
" } }, "com.amazonaws.bedrockagentruntime#InvocationStepPayload": { "type": "union", "members": { "contentBlocks": { "target": "com.amazonaws.bedrockagentruntime#BedrockSessionContentBlocks", "traits": { "smithy.api#documentation": "The content for the invocation step.
" } } }, "traits": { "smithy.api#documentation": "Payload content, such as text and images, for the invocation step.
" } }, "com.amazonaws.bedrockagentruntime#InvocationStepResource": { "type": "resource", "identifiers": { "sessionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier" }, "invocationIdentifier": { "target": "com.amazonaws.bedrockagentruntime#InvocationIdentifier" }, "invocationStepId": { "target": "com.amazonaws.bedrockagentruntime#Uuid" } }, "create": { "target": "com.amazonaws.bedrockagentruntime#PutInvocationStep" }, "read": { "target": "com.amazonaws.bedrockagentruntime#GetInvocationStep" }, "list": { "target": "com.amazonaws.bedrockagentruntime#ListInvocationSteps" } }, "com.amazonaws.bedrockagentruntime#InvocationStepSummaries": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#InvocationStepSummary" } }, "com.amazonaws.bedrockagentruntime#InvocationStepSummary": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier for the session associated with the invocation step.
", "smithy.api#required": {} } }, "invocationId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "A unique identifier for the invocation in UUID format.
", "smithy.api#required": {} } }, "invocationStepId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier (in UUID format) for the invocation step.
", "smithy.api#required": {} } }, "invocationStepTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the invocation step was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
" } }, "com.amazonaws.bedrockagentruntime#InvocationSummaries": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#InvocationSummary" } }, "com.amazonaws.bedrockagentruntime#InvocationSummary": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier for the session associated with the invocation.
", "smithy.api#required": {} } }, "invocationId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "A unique identifier for the invocation in UUID format.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the invocation was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
" } }, "com.amazonaws.bedrockagentruntime#InvocationType": { "type": "enum", "members": { "ACTION_GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_GROUP" } }, "KNOWLEDGE_BASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KNOWLEDGE_BASE" } }, "FINISH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FINISH" } }, "ACTION_GROUP_CODE_INTERPRETER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_GROUP_CODE_INTERPRETER" } }, "AGENT_COLLABORATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGENT_COLLABORATOR" } } } }, "com.amazonaws.bedrockagentruntime#InvokeAgent": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#InvokeAgentRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#InvokeAgentResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ModelNotReadyException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see Amazon Bedrock Agents Classic availability change.
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.
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 unique identifier of the agent to use.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "agentAliasId": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", "traits": { "smithy.api#documentation": "The alias of the agent to use.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#documentation": "The unique identifier of the session. Use the same value across requests to continue the same conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "endSession": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to end the session with the agent or not.
" } }, "enableTrace": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
" } }, "inputText": { "target": "com.amazonaws.bedrockagentruntime#InputText", "traits": { "smithy.api#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.
" } }, "bedrockModelConfigurations": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelConfigurations", "traits": { "smithy.api#documentation": "Model performance settings for the request.
" } }, "streamingConfigurations": { "target": "com.amazonaws.bedrockagentruntime#StreamingConfigurations", "traits": { "smithy.api#documentation": "Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
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 ARN of the resource making the request.
", "smithy.api#httpHeader": "x-amz-source-arn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#InvokeAgentResponse": { "type": "structure", "members": { "completion": { "target": "com.amazonaws.bedrockagentruntime#ResponseStream", "traits": { "smithy.api#documentation": "The agent's response to the user prompt.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.bedrockagentruntime#MimeType", "traits": { "smithy.api#documentation": "The MIME type of the input data in the request. The default value is application/json.
The unique identifier of the session with the agent.
", "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", "smithy.api#required": {} } }, "memoryId": { "target": "com.amazonaws.bedrockagentruntime#MemoryId", "traits": { "smithy.api#documentation": "The unique identifier of the agent memory.
", "smithy.api#httpHeader": "x-amz-bedrock-agent-memory-id" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#InvokeFlow": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#InvokeFlowRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#InvokeFlowResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
The unique identifier of the flow.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "inputs": { "target": "com.amazonaws.bedrockagentruntime#FlowInputs", "traits": { "smithy.api#documentation": "A list of objects, each containing information about an input into the flow.
", "smithy.api#required": {} } }, "enableTrace": { "target": "smithy.api#Boolean", "traits": { "smithy.api#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.
" } }, "modelPerformanceConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ModelPerformanceConfiguration", "traits": { "smithy.api#documentation": "Model performance settings for the request.
" } }, "executionId": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionId", "traits": { "smithy.api#documentation": "The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#InvokeFlowResponse": { "type": "structure", "members": { "responseStream": { "target": "com.amazonaws.bedrockagentruntime#FlowResponseStream", "traits": { "smithy.api#documentation": "The output of the flow, returned as a stream. If there's an error, the error is returned.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "executionId": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionId", "traits": { "smithy.api#documentation": "The unique identifier for the current flow execution.
", "smithy.api#httpHeader": "x-amz-bedrock-flow-execution-id" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#InvokeInlineAgent": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#InvokeInlineAgentRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#InvokeInlineAgentResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.
Specify the following fields for security purposes.
(Optional) customerEncryptionKeyArn \u2013 The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
(Optional) idleSessionTTLinSeconds \u2013 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.
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
" } }, "foundationModel": { "target": "com.amazonaws.bedrockagentruntime#ModelIdentifier", "traits": { "smithy.api#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 instructions that tell the inline agent what it should do and how it should interact with users.
", "smithy.api#required": {} } }, "idleSessionTTLInSeconds": { "target": "com.amazonaws.bedrockagentruntime#SessionTTL", "traits": { "smithy.api#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.
" } }, "actionGroups": { "target": "com.amazonaws.bedrockagentruntime#AgentActionGroups", "traits": { "smithy.api#documentation": "A list of action groups with each action group defining the action the inline agent needs to carry out.
" } }, "knowledgeBases": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBases", "traits": { "smithy.api#documentation": "Contains information of the knowledge bases to associate with.
" } }, "guardrailConfiguration": { "target": "com.amazonaws.bedrockagentruntime#GuardrailConfigurationWithArn", "traits": { "smithy.api#documentation": "The guardrails to assign to the inline agent.
" } }, "promptOverrideConfiguration": { "target": "com.amazonaws.bedrockagentruntime#PromptOverrideConfiguration", "traits": { "smithy.api#documentation": "Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
" } }, "agentCollaboration": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboration", "traits": { "smithy.api#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.
" } }, "collaboratorConfigurations": { "target": "com.amazonaws.bedrockagentruntime#CollaboratorConfigurations", "traits": { "smithy.api#documentation": "Settings for an inline agent collaborator called with InvokeInlineAgent.
" } }, "agentName": { "target": "com.amazonaws.bedrockagentruntime#Name", "traits": { "smithy.api#documentation": "The name for the agent.
" } }, "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#documentation": "The unique identifier of the session. Use the same value across requests to continue the same conversation.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "endSession": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to end the session with the inline agent or not.
" } }, "enableTrace": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
" } }, "inputText": { "target": "com.amazonaws.bedrockagentruntime#InputText", "traits": { "smithy.api#documentation": "The prompt text to send to the agent.
If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.
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.
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.
List of collaborator inline agents.
" } }, "bedrockModelConfigurations": { "target": "com.amazonaws.bedrockagentruntime#InlineBedrockModelConfigurations", "traits": { "smithy.api#documentation": "Model settings for the request.
" } }, "orchestrationType": { "target": "com.amazonaws.bedrockagentruntime#OrchestrationType", "traits": { "smithy.api#documentation": "Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
" } }, "customOrchestration": { "target": "com.amazonaws.bedrockagentruntime#CustomOrchestration", "traits": { "smithy.api#documentation": "Contains details of the custom orchestration configured for the agent.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#InvokeInlineAgentResponse": { "type": "structure", "members": { "completion": { "target": "com.amazonaws.bedrockagentruntime#InlineAgentResponseStream", "traits": { "smithy.api#documentation": "The inline agent's response to the user prompt.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "contentType": { "target": "com.amazonaws.bedrockagentruntime#MimeType", "traits": { "smithy.api#documentation": "The MIME type of the input data in the request. The default value is application/json.
", "smithy.api#httpHeader": "x-amzn-bedrock-agent-content-type", "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#documentation": "The unique identifier of the session with the agent.
", "smithy.api#httpHeader": "x-amz-bedrock-agent-session-id", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#KmsKeyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBase": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", "traits": { "smithy.api#documentation": "The unique identifier for a knowledge base associated with the inline agent.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagentruntime#ResourceDescription", "traits": { "smithy.api#documentation": "The description of the knowledge base associated with the inline agent.
", "smithy.api#required": {} } }, "retrievalConfiguration": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", "traits": { "smithy.api#documentation": "The configurations to apply to the knowledge base during query. For more information, see Query configurations.
" } } }, "traits": { "smithy.api#documentation": "Details of the knowledge base associated withe inline agent.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseArn": { "type": "string", "traits": { "smithy.api#length": { "max": 128 }, "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfiguration": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseId", "traits": { "smithy.api#documentation": "The unique identifier for a knowledge base attached to the agent.
", "smithy.api#required": {} } }, "retrievalConfiguration": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", "traits": { "smithy.api#documentation": "The configurations to apply to the knowledge base during query. For more information, see Query configurations.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configurations to apply to a knowledge base attached to the agent during query. For more information, see Knowledge base retrieval configurations.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfigurations": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfiguration" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseId": { "type": "string", "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#pattern": "^[0-9a-zA-Z]+$" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 2048 }, "smithy.api#pattern": "^[0-9a-zA-Z]{10}$|^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:knowledge-base/[0-9a-zA-Z]{10}$" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInput": { "type": "structure", "members": { "text": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString", "traits": { "smithy.api#documentation": "The query made to the knowledge base.
" } }, "knowledgeBaseId": { "target": "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId", "traits": { "smithy.api#documentation": "The unique identifier of the knowledge base to look up.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the knowledge base to look up and the query to be made.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupInputString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput": { "type": "structure", "members": { "retrievedReferences": { "target": "com.amazonaws.bedrockagentruntime#RetrievedReferences", "traits": { "smithy.api#documentation": "Contains metadata about the sources cited for the generated response.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Contains information about the knowledge base output.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the results from looking up the knowledge base.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseQueryType", "traits": { "smithy.api#default": "TEXT", "smithy.api#documentation": "The type of query being performed.
" } }, "text": { "target": "smithy.api#String", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "The text of the query made to the knowledge base.
", "smithy.api#length": { "max": 20000 } } }, "image": { "target": "com.amazonaws.bedrockagentruntime#InputImage", "traits": { "smithy.api#documentation": "An image to include in the knowledge base query for multimodal retrieval.
" } } }, "traits": { "smithy.api#documentation": "Contains the query made to the knowledge base.
This data type is used in the following API operations:
Retrieve request \u2013 in the retrievalQuery field
Contains details about how the results from the vector search should be returned. For more information, see Query configurations.
" } }, "managedSearchConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ManagedSearchConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for managed search. For more information, see Query configurations.
" } } }, "traits": { "smithy.api#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 \u2013 in the retrievalConfiguration field
RetrieveAndGenerate request \u2013 in the retrievalConfiguration field
Contains information about the content of the chunk.
", "smithy.api#required": {} } }, "location": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation", "traits": { "smithy.api#documentation": "Contains information about the location of the data source.
" } }, "score": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "The level of relevance of the result to the query.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultMetadata", "traits": { "smithy.api#documentation": "Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" } }, "documentId": { "target": "com.amazonaws.bedrockagentruntime#DocumentId", "traits": { "smithy.api#documentation": "The unique identifier of the document. Use with GetDocumentContent to retrieve the full document.
Details about a result from querying the knowledge base.
This data type is used in the following API operations:
Retrieve response \u2013 in the retrievalResults field
The unique identifier of the knowledge base that is queried.
", "smithy.api#required": {} } }, "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { "smithy.api#documentation": "The ARN of the foundation model or inference profile used to generate a response.
", "smithy.api#required": {} } }, "retrievalConfiguration": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for how to retrieve and return the knowledge base query.
" } }, "generationConfiguration": { "target": "com.amazonaws.bedrockagentruntime#GenerationConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for response generation based on the knowledge base query results.
" } }, "orchestrationConfiguration": { "target": "com.amazonaws.bedrockagentruntime#OrchestrationConfiguration", "traits": { "smithy.api#documentation": "Settings for how the model processes the prompt prior to retrieval and generation.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the resource being queried.
This data type is used in the following API operations:
Retrieve request \u2013 in the knowledgeBaseConfiguration field
RetrieveAndGenerate request \u2013 in the knowledgeBaseConfiguration field
The unique identifier of the knowledge base.
", "smithy.api#required": {} } }, "retrievalOverrides": { "target": "com.amazonaws.bedrockagentruntime#RetrievalOverrides", "traits": { "smithy.api#documentation": "Overrides for retrieval behavior such as filters and result limits.
" } } }, "traits": { "smithy.api#documentation": "Configuration for retrieving from a Bedrock knowledge base.
" } }, "com.amazonaws.bedrockagentruntime#KnowledgeBaseVectorSearchConfiguration": { "type": "structure", "members": { "numberOfResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": 5, "smithy.api#documentation": "The number of source chunks to retrieve.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "overrideSearchType": { "target": "com.amazonaws.bedrockagentruntime#SearchType", "traits": { "smithy.api#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.
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see Query configurations.
" } }, "rerankingConfiguration": { "target": "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for reranking the retrieved results. For more information, see Improve the relevance of query responses with a reranker model.
" } }, "implicitFilterConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ImplicitFilterConfiguration", "traits": { "smithy.api#documentation": "Settings for implicit filtering.
" } } }, "traits": { "smithy.api#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 \u2013 in the vectorSearchConfiguration field
RetrieveAndGenerate request \u2013 in the vectorSearchConfiguration field
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.
The unique identifier of the flow.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow execution.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.bedrockagentruntime#MaxResults", "traits": { "smithy.api#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.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#documentation": "A token to retrieve the next set of results. This value is returned in the response if more results are available.
", "smithy.api#httpQuery": "nextToken" } }, "eventType": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionEventType", "traits": { "smithy.api#documentation": "The type of events to retrieve. Specify Node for node-level events or Flow for flow-level events.
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.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#documentation": "A token to retrieve the next set of results. This value is returned if more results are available.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#ListFlowExecutions": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutionsRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#ListFlowExecutionsResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
The unique identifier of the flow to list executions for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias to list executions for.
", "smithy.api#httpQuery": "flowAliasIdentifier" } }, "maxResults": { "target": "com.amazonaws.bedrockagentruntime#MaxResults", "traits": { "smithy.api#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.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#ListFlowExecutionsResponse": { "type": "structure", "members": { "flowExecutionSummaries": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionSummaries", "traits": { "smithy.api#documentation": "A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#documentation": "A token to retrieve the next set of results. This value is returned if more results are available.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#ListInvocationSteps": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#ListInvocationStepsRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#ListInvocationStepsResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "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.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/sessions/{sessionIdentifier}/invocationSteps/" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "invocationStepSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#ListInvocationStepsRequest": { "type": "structure", "members": { "invocationIdentifier": { "target": "com.amazonaws.bedrockagentruntime#InvocationIdentifier", "traits": { "smithy.api#documentation": "The unique identifier (in UUID format) for the invocation to list invocation steps for.
" } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#documentation": "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 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.
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.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#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.
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.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/sessions/{sessionIdentifier}/invocations/" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "invocationSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#ListInvocationsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#documentation": "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 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.
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.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#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.
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.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/sessions/" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "sessionSummaries" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#ListSessionsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.bedrockagentruntime#MaxResults", "traits": { "smithy.api#default": 10, "smithy.api#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.
A list of summaries for each session in your Amazon Web Services account.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#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.
List all the tags for the resource you specify.
", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.bedrockagentruntime#TaggableResourcesArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to list tags.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.bedrockagentruntime#TagsMap", "traits": { "smithy.api#documentation": "The key-value pairs for the tags associated with the resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#ManagedSearchBedrockRerankingConfiguration": { "type": "structure", "members": { "modelConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ManagedSearchBedrockRerankingModelConfiguration", "traits": { "smithy.api#documentation": "The model configuration containing the model ARN for reranking.
", "smithy.api#required": {} } }, "numberOfRerankedResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of results to return after reranking.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "metadataConfiguration": { "target": "com.amazonaws.bedrockagentruntime#MetadataConfigurationForReranking", "traits": { "smithy.api#documentation": "The metadata configuration for reranking.
" } } }, "traits": { "smithy.api#documentation": "Configuration for a Bedrock reranking model used in managed search.
" } }, "com.amazonaws.bedrockagentruntime#ManagedSearchBedrockRerankingModelConfiguration": { "type": "structure", "members": { "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockRerankingModelArn", "traits": { "smithy.api#documentation": "The ARN of the Bedrock reranking model.
", "smithy.api#required": {} } }, "additionalModelRequestFields": { "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", "traits": { "smithy.api#documentation": "Additional request fields to pass to the reranking model.
" } } }, "traits": { "smithy.api#documentation": "Model configuration for a Bedrock reranking model used in managed search.
" } }, "com.amazonaws.bedrockagentruntime#ManagedSearchConfiguration": { "type": "structure", "members": { "numberOfResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of results to retrieve.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "filter": { "target": "com.amazonaws.bedrockagentruntime#RetrievalFilter", "traits": { "smithy.api#documentation": "Filters the metadata of the retrieved results so that Amazon Bedrock returns only results that match the filter.
" } }, "rerankingModelType": { "target": "com.amazonaws.bedrockagentruntime#RerankingModelType", "traits": { "smithy.api#documentation": "The type of reranking model to use when reranking results retrieved from the managed search. Use CUSTOM to specify a model, MANAGED to use the service default, or NONE to disable reranking.
Contains configurations for reranking the results retrieved from the managed search.
" } } }, "traits": { "smithy.api#documentation": "Configuration for managed search in a knowledge base. Managed search automatically determines the best search strategy based on your data store configuration.
" } }, "com.amazonaws.bedrockagentruntime#ManagedSearchRerankingConfiguration": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#ManagedSearchRerankingConfigurationType", "traits": { "smithy.api#documentation": "The type of reranking configuration.
", "smithy.api#required": {} } }, "bedrockRerankingConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ManagedSearchBedrockRerankingConfiguration", "traits": { "smithy.api#documentation": "The Bedrock reranking model configuration for managed search.
" } } }, "traits": { "smithy.api#documentation": "Configuration for the reranking model used in managed search.
" } }, "com.amazonaws.bedrockagentruntime#ManagedSearchRerankingConfigurationType": { "type": "enum", "members": { "BEDROCK_RERANKING_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" } } }, "traits": { "smithy.api#documentation": "The type of reranking configuration for managed search.
" } }, "com.amazonaws.bedrockagentruntime#MantleFoundationModelConfiguration": { "type": "structure", "members": { "modelConfiguration": { "target": "com.amazonaws.bedrockagentruntime#MantleFoundationModelModelConfiguration", "traits": { "smithy.api#documentation": "The model configuration containing the model ARN and project ID.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Configuration for a Mantle foundation model.
" } }, "com.amazonaws.bedrockagentruntime#MantleFoundationModelModelConfiguration": { "type": "structure", "members": { "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockModelArn", "traits": { "smithy.api#documentation": "The ARN of the Mantle foundation model.
", "smithy.api#required": {} } }, "projectId": { "target": "com.amazonaws.bedrockagentruntime#MantleProjectId", "traits": { "smithy.api#documentation": "The Amazon Bedrock project ID used for billing and usage attribution. If you don't specify a value, the service uses the default project.
" } } }, "traits": { "smithy.api#documentation": "Model configuration for a Mantle foundation model.
" } }, "com.amazonaws.bedrockagentruntime#MantleProjectId": { "type": "string", "traits": { "smithy.api#length": { "max": 128 }, "smithy.api#pattern": "^(proj_[a-zA-Z0-9]+|default)$" } }, "com.amazonaws.bedrockagentruntime#MaxResults": { "type": "integer", "traits": { "smithy.api#documentation": "Max Results.", "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.bedrockagentruntime#MaxTokens": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 65536 } } }, "com.amazonaws.bedrockagentruntime#MaximumLength": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 8192 } } }, "com.amazonaws.bedrockagentruntime#MediaId": { "type": "string", "traits": { "smithy.api#documentation": "The unique identifier of an image embedded in a document.
", "smithy.api#length": { "min": 36, "max": 36 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{35}$" } }, "com.amazonaws.bedrockagentruntime#Memories": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Memory" } }, "com.amazonaws.bedrockagentruntime#Memory": { "type": "union", "members": { "sessionSummary": { "target": "com.amazonaws.bedrockagentruntime#MemorySessionSummary", "traits": { "smithy.api#documentation": "Contains summary of a session.
" } } }, "traits": { "smithy.api#documentation": "Contains sessions summaries.
" } }, "com.amazonaws.bedrockagentruntime#MemoryId": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 100 }, "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" } }, "com.amazonaws.bedrockagentruntime#MemoryNamespace": { "type": "string", "traits": { "smithy.api#documentation": "A namespace in an AgentCore Memory resource, supplied exactly as configured on the memory strategy. The service does not accept placeholder templates such as {actorId}. Supply the resolved value.
", "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[a-zA-Z0-9/*][a-zA-Z0-9\\-_/*]*(?::[a-zA-Z0-9\\-_/*]+)*[a-zA-Z0-9\\-_/*]*$" } }, "com.amazonaws.bedrockagentruntime#MemoryResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#DeleteAgentMemory" }, { "target": "com.amazonaws.bedrockagentruntime#GetAgentMemory" } ] }, "com.amazonaws.bedrockagentruntime#MemorySessionSummary": { "type": "structure", "members": { "memoryId": { "target": "com.amazonaws.bedrockagentruntime#MemoryId", "traits": { "smithy.api#documentation": "The unique identifier of the memory where the session summary is stored.
" } }, "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#documentation": "The identifier for this session.
" } }, "sessionStartTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The start time for this session.
" } }, "sessionExpiryTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The time when the memory duration for the session is set to end.
" } }, "summaryText": { "target": "com.amazonaws.bedrockagentruntime#SummaryText", "traits": { "smithy.api#documentation": "The summarized text for this session.
" } } }, "traits": { "smithy.api#documentation": "Contains details of a session summary.
" } }, "com.amazonaws.bedrockagentruntime#MemoryStrategyId": { "type": "string", "traits": { "smithy.api#documentation": "The identifier of an extraction strategy configured on the memory resource. Omit this value to retrieve records from every strategy on the memory resource.
", "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*$" } }, "com.amazonaws.bedrockagentruntime#MemoryType": { "type": "enum", "members": { "SESSION_SUMMARY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SESSION_SUMMARY" } } } }, "com.amazonaws.bedrockagentruntime#Message": { "type": "structure", "members": { "role": { "target": "com.amazonaws.bedrockagentruntime#ConversationRole", "traits": { "smithy.api#documentation": "The message's role.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.bedrockagentruntime#ContentBlocks", "traits": { "smithy.api#documentation": "The message's content.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Details about a message.
" } }, "com.amazonaws.bedrockagentruntime#Messages": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Message" } }, "com.amazonaws.bedrockagentruntime#Metadata": { "type": "structure", "members": { "startTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "In the final response, startTime is the start time of the agent invocation operation.
In the final response, endTime is the end 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.
" } }, "operationTotalTimeMs": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "The total time it took for the agent to complete execution. This field is only set for the final response.
" } }, "clientRequestId": { "target": "smithy.api#String", "traits": { "smithy.api#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.
" } }, "usage": { "target": "com.amazonaws.bedrockagentruntime#Usage", "traits": { "smithy.api#documentation": "Specific to model invocation and contains details about the usage of a foundation model.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#MetadataAttributeSchema": { "type": "structure", "members": { "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The attribute's key.
", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\s\\S]+$", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.bedrockagentruntime#AttributeType", "traits": { "smithy.api#documentation": "The attribute's type.
", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The attribute's description.
", "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\s\\S]+$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Details about a metadata attribute.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#MetadataAttributeSchemaList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#MetadataAttributeSchema" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.bedrockagentruntime#MetadataConfigurationForReranking": { "type": "structure", "members": { "selectionMode": { "target": "com.amazonaws.bedrockagentruntime#RerankingMetadataSelectionMode", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#documentation": "Contains configurations for the metadata to use in reranking.
" } }, "com.amazonaws.bedrockagentruntime#MimeType": { "type": "string" }, "com.amazonaws.bedrockagentruntime#ModelIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#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-:.]+)$" } }, "com.amazonaws.bedrockagentruntime#ModelInvocationInput": { "type": "structure", "members": { "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { "smithy.api#documentation": "The unique identifier of the trace.
" } }, "text": { "target": "com.amazonaws.bedrockagentruntime#PromptText", "traits": { "smithy.api#documentation": "The text that prompted the agent at this step.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#PromptType", "traits": { "smithy.api#documentation": "The step in the agent sequence.
" } }, "overrideLambda": { "target": "com.amazonaws.bedrockagentruntime#LambdaArn", "traits": { "smithy.api#documentation": "The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
" } }, "promptCreationMode": { "target": "com.amazonaws.bedrockagentruntime#CreationMode", "traits": { "smithy.api#documentation": "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.
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.
" } }, "parserMode": { "target": "com.amazonaws.bedrockagentruntime#CreationMode", "traits": { "smithy.api#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.
The identifier of a foundation model.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#error": "client", "smithy.api#httpError": 424 } }, "com.amazonaws.bedrockagentruntime#ModelPerformanceConfiguration": { "type": "structure", "members": { "performanceConfig": { "target": "com.amazonaws.bedrockagentruntime#PerformanceConfiguration", "traits": { "smithy.api#documentation": "The latency configuration for the model.
" } } }, "traits": { "smithy.api#documentation": "The performance configuration for a model called with InvokeFlow.
" } }, "com.amazonaws.bedrockagentruntime#Name": { "type": "string", "traits": { "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^\\S*$" } }, "com.amazonaws.bedrockagentruntime#NodeActionEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the node that called the operation.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The date and time that the operation was called.
", "smithy.api#required": {} } }, "requestId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the request that the node made to the operation.
", "smithy.api#required": {} } }, "serviceName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the service that the node called.
", "smithy.api#required": {} } }, "operationName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the operation that the node called.
", "smithy.api#required": {} } }, "operationRequest": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The request payload sent to the downstream service.
" } }, "operationResponse": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The response payload received from the downstream service.
" } } }, "traits": { "smithy.api#documentation": "Contains information about an action (operation) called by a node during execution.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#NodeDependencyEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the node that generated the dependency trace.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The date and time that the dependency trace was generated.
", "smithy.api#required": {} } }, "traceElements": { "target": "com.amazonaws.bedrockagentruntime#NodeTraceElements", "traits": { "smithy.api#documentation": "The trace elements containing detailed information about the node execution.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about an internal trace of a specific node during execution.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#NodeErrorCode": { "type": "enum", "members": { "VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VALIDATION" } }, "DEPENDENCY_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPENDENCY_FAILED" } }, "BAD_GATEWAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BAD_GATEWAY" } }, "INTERNAL_SERVER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_SERVER" } } } }, "com.amazonaws.bedrockagentruntime#NodeExecutionContent": { "type": "union", "members": { "document": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "The document content of the field, which can contain text or structured data.
" } } }, "traits": { "smithy.api#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 name of the node where the failure occurred.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the node failure occurred.
", "smithy.api#required": {} } }, "errorCode": { "target": "com.amazonaws.bedrockagentruntime#NodeErrorCode", "traits": { "smithy.api#documentation": "The error code that identifies the type of failure that occurred at the node.
", "smithy.api#required": {} } }, "errorMessage": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A descriptive message that provides details about the node failure.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
The name of the node that received the inputs.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the inputs were provided to the node.
", "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.bedrockagentruntime#NodeInputFields", "traits": { "smithy.api#documentation": "A list of input fields provided to the node.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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 name of the node in the execution chain.
", "smithy.api#required": {} } }, "index": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The index position of this item in the execution chain.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#FlowControlNodeType", "traits": { "smithy.api#documentation": "The type of execution chain item. Supported values are Iterator and Loop.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents an item in the execution chain for node input tracking.
" } }, "com.amazonaws.bedrockagentruntime#NodeInputField": { "type": "structure", "members": { "name": { "target": "com.amazonaws.bedrockagentruntime#NodeInputName", "traits": { "smithy.api#documentation": "The name of the input field as defined in the node's input schema.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.bedrockagentruntime#NodeExecutionContent", "traits": { "smithy.api#documentation": "The content of the input field, which can contain text or structured data.
", "smithy.api#required": {} } }, "source": { "target": "com.amazonaws.bedrockagentruntime#NodeInputSource", "traits": { "smithy.api#documentation": "The source node that provides input data to this field.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", "traits": { "smithy.api#documentation": "The data type of the input field for compatibility validation.
" } }, "category": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputCategory", "traits": { "smithy.api#documentation": "The category of the input field.
" } }, "executionChain": { "target": "com.amazonaws.bedrockagentruntime#NodeInputExecutionChain", "traits": { "smithy.api#documentation": "The execution path through nested nodes like iterators and loops.
" } } }, "traits": { "smithy.api#documentation": "Represents an input field provided to a node during a flow execution.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#NodeInputFields": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#NodeInputField" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.bedrockagentruntime#NodeInputName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" } }, "com.amazonaws.bedrockagentruntime#NodeInputSource": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the source node that provides the input data.
", "smithy.api#required": {} } }, "outputFieldName": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeOutputName", "traits": { "smithy.api#documentation": "The name of the output field from the source node.
", "smithy.api#required": {} } }, "expression": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputExpression", "traits": { "smithy.api#documentation": "The expression used to extract data from the source.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the source of input data for a node field.
" } }, "com.amazonaws.bedrockagentruntime#NodeName": { "type": "string", "traits": { "smithy.api#pattern": "^[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}$" } }, "com.amazonaws.bedrockagentruntime#NodeOutputEvent": { "type": "structure", "members": { "nodeName": { "target": "com.amazonaws.bedrockagentruntime#NodeName", "traits": { "smithy.api#documentation": "The name of the node that produced the outputs.
", "smithy.api#required": {} } }, "timestamp": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp when the outputs were produced by the node.
", "smithy.api#required": {} } }, "fields": { "target": "com.amazonaws.bedrockagentruntime#NodeOutputFields", "traits": { "smithy.api#documentation": "A list of output fields produced by the node.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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 name of the output field as defined in the node's output schema.
", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.bedrockagentruntime#NodeExecutionContent", "traits": { "smithy.api#documentation": "The content of the output field, which can contain text or structured data.
", "smithy.api#required": {} } }, "next": { "target": "com.amazonaws.bedrockagentruntime#NodeOutputNextList", "traits": { "smithy.api#documentation": "The next node that receives output data from this field.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeIODataType", "traits": { "smithy.api#documentation": "The data type of the output field for compatibility validation.
" } } }, "traits": { "smithy.api#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 next node that receives the output data.
", "smithy.api#required": {} } }, "inputFieldName": { "target": "com.amazonaws.bedrockagentruntime#FlowNodeInputName", "traits": { "smithy.api#documentation": "The name of the input field in the next node that receives the data.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Represents the next node that receives output data.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#NodeOutputNextList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#NodeOutputNext" } }, "com.amazonaws.bedrockagentruntime#NodeTraceElements": { "type": "union", "members": { "agentTraces": { "target": "com.amazonaws.bedrockagentruntime#AgentTraces", "traits": { "smithy.api#documentation": "Agent trace information for the node execution.
" } } }, "traits": { "smithy.api#documentation": "Contains trace elements for node execution tracking.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#NodeType": { "type": "enum", "members": { "FLOW_INPUT_NODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FlowInputNode" } }, "FLOW_OUTPUT_NODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FlowOutputNode" } }, "LAMBDA_FUNCTION_NODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LambdaFunctionNode" } }, "KNOWLEDGE_BASE_NODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KnowledgeBaseNode" } }, "PROMPT_NODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PromptNode" } }, "CONDITION_NODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ConditionNode" } }, "LEX_NODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LexNode" } } } }, "com.amazonaws.bedrockagentruntime#NonBlankString": { "type": "string", "traits": { "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.bedrockagentruntime#Observation": { "type": "structure", "members": { "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { "smithy.api#documentation": "The unique identifier of the trace.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#Type", "traits": { "smithy.api#documentation": "Specifies what kind of information the agent returns in the observation. The following values are possible.
ACTION_GROUP \u2013 The agent returns the result of an action group.
KNOWLEDGE_BASE \u2013 The agent returns information from a knowledge base.
FINISH \u2013 The agent returns a final response to the user with no follow-up.
ASK_USER \u2013 The agent asks the user a question.
REPROMPT \u2013 The agent prompts the user again for the same information.
Contains the JSON-formatted string returned by the API invoked by the action group.
" } }, "agentCollaboratorInvocationOutput": { "target": "com.amazonaws.bedrockagentruntime#AgentCollaboratorInvocationOutput", "traits": { "smithy.api#documentation": "A collaborator's invocation output.
" } }, "knowledgeBaseLookupOutput": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseLookupOutput", "traits": { "smithy.api#documentation": "Contains details about the results from looking up the knowledge base.
" } }, "finalResponse": { "target": "com.amazonaws.bedrockagentruntime#FinalResponse", "traits": { "smithy.api#documentation": "Contains details about the response to the user.
" } }, "repromptResponse": { "target": "com.amazonaws.bedrockagentruntime#RepromptResponse", "traits": { "smithy.api#documentation": "Contains details about the response to reprompt the input.
" } }, "codeInterpreterInvocationOutput": { "target": "com.amazonaws.bedrockagentruntime#CodeInterpreterInvocationOutput", "traits": { "smithy.api#documentation": "Contains the JSON-formatted string returned by the API invoked by the code interpreter.
" } } }, "traits": { "smithy.api#documentation": "Contains the result or output of an action group or knowledge base, or the response to the user.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#OptimizePrompt": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#OptimizePromptRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#OptimizePromptResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Optimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/optimize-prompt" } } }, "com.amazonaws.bedrockagentruntime#OptimizePromptRequest": { "type": "structure", "members": { "input": { "target": "com.amazonaws.bedrockagentruntime#InputPrompt", "traits": { "smithy.api#documentation": "Contains the prompt to optimize.
", "smithy.api#required": {} } }, "targetModelId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The unique identifier of the model that you want to optimize the prompt for.
", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#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][_-]?)+)$", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#OptimizePromptResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#OptimizePrompt" } ] }, "com.amazonaws.bedrockagentruntime#OptimizePromptResponse": { "type": "structure", "members": { "optimizedPrompt": { "target": "com.amazonaws.bedrockagentruntime#OptimizedPromptStream", "traits": { "smithy.api#documentation": "The prompt after being optimized for the task.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#OptimizedPrompt": { "type": "union", "members": { "textPrompt": { "target": "com.amazonaws.bedrockagentruntime#TextPrompt", "traits": { "smithy.api#documentation": "Contains information about the text in the prompt that was optimized.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the optimized prompt.
" } }, "com.amazonaws.bedrockagentruntime#OptimizedPromptEvent": { "type": "structure", "members": { "optimizedPrompt": { "target": "com.amazonaws.bedrockagentruntime#OptimizedPrompt", "traits": { "smithy.api#documentation": "Contains information about the optimized prompt.
" } } }, "traits": { "smithy.api#documentation": "An event in which the prompt was optimized.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#OptimizedPromptStream": { "type": "union", "members": { "optimizedPromptEvent": { "target": "com.amazonaws.bedrockagentruntime#OptimizedPromptEvent", "traits": { "smithy.api#documentation": "An event in which the prompt was optimized.
" } }, "analyzePromptEvent": { "target": "com.amazonaws.bedrockagentruntime#AnalyzePromptEvent", "traits": { "smithy.api#documentation": "An event in which the prompt was analyzed in preparation for optimization.
" } }, "internalServerException": { "target": "com.amazonaws.bedrockagentruntime#InternalServerException", "traits": { "smithy.api#documentation": "An internal server error occurred. Retry your request.
" } }, "throttlingException": { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", "traits": { "smithy.api#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": { "target": "com.amazonaws.bedrockagentruntime#ValidationException", "traits": { "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" } }, "dependencyFailedException": { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", "traits": { "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
" } }, "accessDeniedException": { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", "traits": { "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
" } }, "badGatewayException": { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", "traits": { "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
" } } }, "traits": { "smithy.api#documentation": "The stream containing events in the prompt optimization process.
", "smithy.api#streaming": {} } }, "com.amazonaws.bedrockagentruntime#OrchestrationConfiguration": { "type": "structure", "members": { "promptTemplate": { "target": "com.amazonaws.bedrockagentruntime#PromptTemplate", "traits": { "smithy.api#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.
Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
" } }, "additionalModelRequestFields": { "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", "traits": { "smithy.api#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.
" } }, "queryTransformationConfiguration": { "target": "com.amazonaws.bedrockagentruntime#QueryTransformationConfiguration", "traits": { "smithy.api#documentation": "To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
The latency configuration for the model.
" } } }, "traits": { "smithy.api#documentation": "Settings for how the model processes the prompt prior to retrieval and generation.
" } }, "com.amazonaws.bedrockagentruntime#OrchestrationExecutor": { "type": "union", "members": { "lambda": { "target": "com.amazonaws.bedrockagentruntime#LambdaArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
" } } }, "traits": { "smithy.api#documentation": "The structure of the executor invoking the actions in custom orchestration.
" } }, "com.amazonaws.bedrockagentruntime#OrchestrationModelInvocationOutput": { "type": "structure", "members": { "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { "smithy.api#documentation": "The unique identifier of the trace.
" } }, "rawResponse": { "target": "com.amazonaws.bedrockagentruntime#RawResponse", "traits": { "smithy.api#documentation": "Contains details of the raw response from the foundation model output.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Contains information about the foundation model output from the orchestration step.
" } }, "reasoningContent": { "target": "com.amazonaws.bedrockagentruntime#ReasoningContentBlock", "traits": { "smithy.api#documentation": "Contains content about the reasoning that the model made during the orchestration step.
" } } }, "traits": { "smithy.api#documentation": "The foundation model output from the orchestration step.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#OrchestrationTrace": { "type": "union", "members": { "rationale": { "target": "com.amazonaws.bedrockagentruntime#Rationale", "traits": { "smithy.api#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.
" } }, "invocationInput": { "target": "com.amazonaws.bedrockagentruntime#InvocationInput", "traits": { "smithy.api#documentation": "Contains information pertaining to the action group or knowledge base that is being invoked.
" } }, "observation": { "target": "com.amazonaws.bedrockagentruntime#Observation", "traits": { "smithy.api#documentation": "Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
" } }, "modelInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#documentation": "Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#OrchestrationType": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } }, "CUSTOM_ORCHESTRATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM_ORCHESTRATION" } } } }, "com.amazonaws.bedrockagentruntime#OutputFile": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the file containing response from code interpreter.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#MimeType", "traits": { "smithy.api#documentation": "The type of file that contains response from the code interpreter.
" } }, "bytes": { "target": "com.amazonaws.bedrockagentruntime#FileBody", "traits": { "smithy.api#documentation": "The byte count of files that contains response from code interpreter.
" } } }, "traits": { "smithy.api#documentation": "Contains details of the response from code interpreter.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#OutputFiles": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#OutputFile" }, "traits": { "smithy.api#length": { "min": 0, "max": 5 } } }, "com.amazonaws.bedrockagentruntime#OutputString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#Parameter": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the parameter.
" } }, "type": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The type of the parameter.
" } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The value of the parameter.
" } } }, "traits": { "smithy.api#documentation": "A parameter for the API request or function.
" } }, "com.amazonaws.bedrockagentruntime#ParameterDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.bedrockagentruntime#ParameterDetail": { "type": "structure", "members": { "description": { "target": "com.amazonaws.bedrockagentruntime#ParameterDescription", "traits": { "smithy.api#documentation": "A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#ParameterType", "traits": { "smithy.api#documentation": "The data type of the parameter.
", "smithy.api#required": {} } }, "required": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the parameter is required for the agent to complete the function for action group invocation.
" } } }, "traits": { "smithy.api#documentation": "Contains details about a parameter in a function for an action group.
" } }, "com.amazonaws.bedrockagentruntime#ParameterList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Parameter" } }, "com.amazonaws.bedrockagentruntime#ParameterMap": { "type": "map", "key": { "target": "com.amazonaws.bedrockagentruntime#ParameterName" }, "value": { "target": "com.amazonaws.bedrockagentruntime#ParameterDetail" } }, "com.amazonaws.bedrockagentruntime#ParameterName": { "type": "string", "traits": { "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" } }, "com.amazonaws.bedrockagentruntime#ParameterType": { "type": "enum", "members": { "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "string" } }, "NUMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "number" } }, "INTEGER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "integer" } }, "BOOLEAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "boolean" } }, "ARRAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "array" } } } }, "com.amazonaws.bedrockagentruntime#Parameters": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#Parameter" } }, "com.amazonaws.bedrockagentruntime#PartBody": { "type": "blob", "traits": { "smithy.api#length": { "max": 1000000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#Payload": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PayloadPart": { "type": "structure", "members": { "bytes": { "target": "com.amazonaws.bedrockagentruntime#PartBody", "traits": { "smithy.api#documentation": "A part of the agent response in bytes.
" } }, "attribution": { "target": "com.amazonaws.bedrockagentruntime#Attribution", "traits": { "smithy.api#documentation": "Contains citations for a part of an agent response.
" } } }, "traits": { "smithy.api#documentation": "Contains a part of an agent response and citations for it.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PayloadType": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEXT" } }, "RETURN_CONTROL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RETURN_CONTROL" } } } }, "com.amazonaws.bedrockagentruntime#PerformanceConfigLatency": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "standard" } }, "OPTIMIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "optimized" } } } }, "com.amazonaws.bedrockagentruntime#PerformanceConfiguration": { "type": "structure", "members": { "latency": { "target": "com.amazonaws.bedrockagentruntime#PerformanceConfigLatency", "traits": { "smithy.api#default": "standard", "smithy.api#documentation": "To use a latency-optimized version of the model, set to optimized.
Performance settings for a model.
" } }, "com.amazonaws.bedrockagentruntime#PostProcessingModelInvocationOutput": { "type": "structure", "members": { "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { "smithy.api#documentation": "The unique identifier of the trace.
" } }, "parsedResponse": { "target": "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse", "traits": { "smithy.api#documentation": "Details about the response from the Lambda parsing of the output of the post-processing step.
" } }, "rawResponse": { "target": "com.amazonaws.bedrockagentruntime#RawResponse", "traits": { "smithy.api#documentation": "Details of the raw response from the foundation model output.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Contains information about the foundation model output from the post-processing step.
" } }, "reasoningContent": { "target": "com.amazonaws.bedrockagentruntime#ReasoningContentBlock", "traits": { "smithy.api#documentation": "Contains content about the reasoning that the model made during the post-processing step.
" } } }, "traits": { "smithy.api#documentation": "The foundation model output from the post-processing step.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PostProcessingParsedResponse": { "type": "structure", "members": { "text": { "target": "com.amazonaws.bedrockagentruntime#OutputString", "traits": { "smithy.api#documentation": "The text returned by the parser.
" } } }, "traits": { "smithy.api#documentation": "Details about the response from the Lambda parsing of the output from the post-processing step.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PostProcessingTrace": { "type": "union", "members": { "modelInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#documentation": "Details about the post-processing step, in which the agent shapes the response.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PreProcessingModelInvocationOutput": { "type": "structure", "members": { "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { "smithy.api#documentation": "The unique identifier of the trace.
" } }, "parsedResponse": { "target": "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse", "traits": { "smithy.api#documentation": "Details about the response from the Lambda parsing of the output of the pre-processing step.
" } }, "rawResponse": { "target": "com.amazonaws.bedrockagentruntime#RawResponse", "traits": { "smithy.api#documentation": "Details of the raw response from the foundation model output.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "Contains information about the foundation model output from the pre-processing step.
" } }, "reasoningContent": { "target": "com.amazonaws.bedrockagentruntime#ReasoningContentBlock", "traits": { "smithy.api#documentation": "Contains content about the reasoning that the model made during the pre-processing step.
" } } }, "traits": { "smithy.api#documentation": "The foundation model output from the pre-processing step.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PreProcessingParsedResponse": { "type": "structure", "members": { "rationale": { "target": "com.amazonaws.bedrockagentruntime#RationaleString", "traits": { "smithy.api#documentation": "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.
" } }, "isValid": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Whether the user input is valid or not. If false, the agent doesn't proceed to orchestration.
Details about the response from the Lambda parsing of the output from the pre-processing step.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PreProcessingTrace": { "type": "union", "members": { "modelInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#documentation": "Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PresignedUrl": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PromptConfiguration": { "type": "structure", "members": { "promptType": { "target": "com.amazonaws.bedrockagentruntime#PromptType", "traits": { "smithy.api#documentation": "The step in the agent sequence that this prompt configuration applies to.
" } }, "promptCreationMode": { "target": "com.amazonaws.bedrockagentruntime#CreationMode", "traits": { "smithy.api#documentation": "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 \u2013 ENABLED
ORCHESTRATION \u2013 ENABLED
KNOWLEDGE_BASE_RESPONSE_GENERATION \u2013 ENABLED
POST_PROCESSING \u2013 DISABLED
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.
" } }, "inferenceConfiguration": { "target": "com.amazonaws.bedrockagentruntime#InferenceConfiguration", "traits": { "smithy.api#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.
The foundation model to use.
" } }, "additionalModelRequestFields": { "target": "smithy.api#Document", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#documentation": "Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
" } }, "com.amazonaws.bedrockagentruntime#PromptConfigurations": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#PromptConfiguration" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.bedrockagentruntime#PromptCreationConfigurations": { "type": "structure", "members": { "previousConversationTurnsToInclude": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "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.
", "smithy.api#range": { "min": 0 } } }, "excludePreviousThinkingSteps": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, "smithy.api#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.
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.
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
", "smithy.api#required": {} } }, "overrideLambda": { "target": "com.amazonaws.bedrockagentruntime#LambdaResourceArn", "traits": { "smithy.api#documentation": "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 prompts in different parts of an agent sequence. For more information, see Advanced prompts.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#PromptSessionAttributesMap": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.bedrockagentruntime#PromptState": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.bedrockagentruntime#PromptTemplate": { "type": "structure", "members": { "textPromptTemplate": { "target": "com.amazonaws.bedrockagentruntime#TextPromptTemplate", "traits": { "smithy.api#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:
" } } }, "traits": { "smithy.api#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 \u2013 in the filter field
A list of parameters in the request body.
" } } }, "traits": { "smithy.api#documentation": "Contains the parameters in the request body.
" } }, "com.amazonaws.bedrockagentruntime#PutInvocationStep": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#PutInvocationStepRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#PutInvocationStepResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#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:
", "smithy.api#http": { "code": 201, "method": "PUT", "uri": "/sessions/{sessionIdentifier}/invocationSteps/" }, "smithy.api#idempotent": {} } }, "com.amazonaws.bedrockagentruntime#PutInvocationStepRequest": { "type": "structure", "members": { "sessionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", "traits": { "smithy.api#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 (in UUID format) of the invocation to add the invocation step to.
", "smithy.api#required": {} } }, "invocationStepTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the invocation step occurred.
", "smithy.api#required": {} } }, "payload": { "target": "com.amazonaws.bedrockagentruntime#InvocationStepPayload", "traits": { "smithy.api#documentation": "The payload for the invocation step, including text and images for the interaction.
", "smithy.api#required": {} } }, "invocationStepId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier of the invocation step in UUID format.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#PutInvocationStepResponse": { "type": "structure", "members": { "invocationStepId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier of the invocation step in UUID format.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#QueryGenerationInput": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#InputQueryType", "traits": { "smithy.api#documentation": "The type of the query.
", "smithy.api#required": {} } }, "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The text of the query.
", "smithy.api#length": { "min": 1, "max": 20000 }, "smithy.api#pattern": "^(?!\\s*$).+", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about a natural language query to transform into SQL.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#QueryTransformationConfiguration": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#QueryTransformationType", "traits": { "smithy.api#documentation": "The type of transformation to apply to the prompt.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "To split up the prompt and retrieve multiple sources, set the transformation type to QUERY_DECOMPOSITION.
The unique identifier of the trace step.
" } }, "text": { "target": "com.amazonaws.bedrockagentruntime#RationaleString", "traits": { "smithy.api#documentation": "The reasoning or thought process of the agent, based on the input.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RationaleString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RawResponse": { "type": "structure", "members": { "content": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The foundation model's raw output content.
" } } }, "traits": { "smithy.api#documentation": "Contains the raw output from the foundation model.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ReasoningContentBlock": { "type": "union", "members": { "reasoningText": { "target": "com.amazonaws.bedrockagentruntime#ReasoningTextBlock", "traits": { "smithy.api#documentation": "Contains information about the reasoning that the model used to return the content in the content block.
" } }, "redactedContent": { "target": "smithy.api#Blob", "traits": { "smithy.api#documentation": "The content in the reasoning that was encrypted by the model provider for trust and safety reasons.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ReasoningTextBlock": { "type": "structure", "members": { "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Text describing the reasoning that the model used to return the content in the content block.
", "smithy.api#required": {} } }, "signature": { "target": "smithy.api#String", "traits": { "smithy.api#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.
Contains information about the reasoning that the model used to return the content in the content block.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RelayConversationHistory": { "type": "enum", "members": { "TO_COLLABORATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TO_COLLABORATOR" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.bedrockagentruntime#RepromptResponse": { "type": "structure", "members": { "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The text reprompting the input.
" } }, "source": { "target": "com.amazonaws.bedrockagentruntime#Source", "traits": { "smithy.api#documentation": "Specifies what output is prompting the agent to reprompt the input.
" } } }, "traits": { "smithy.api#documentation": "Contains details about the agent's response to reprompt the input.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RequestBody": { "type": "structure", "members": { "content": { "target": "com.amazonaws.bedrockagentruntime#ContentMap", "traits": { "smithy.api#documentation": "The content in the request body.
" } } }, "traits": { "smithy.api#documentation": "The parameters in the API request body.
" } }, "com.amazonaws.bedrockagentruntime#RequireConfirmation": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.bedrockagentruntime#Rerank": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#RerankRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#RerankResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/rerank" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "results" } } }, "com.amazonaws.bedrockagentruntime#RerankDocument": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#RerankDocumentType", "traits": { "smithy.api#documentation": "The type of document to rerank.
", "smithy.api#required": {} } }, "textDocument": { "target": "com.amazonaws.bedrockagentruntime#RerankTextDocument", "traits": { "smithy.api#documentation": "Contains information about a text document to rerank.
" } }, "jsonDocument": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "Contains a JSON document to rerank.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.
The type of the query.
", "smithy.api#required": {} } }, "textQuery": { "target": "com.amazonaws.bedrockagentruntime#RerankTextDocument", "traits": { "smithy.api#documentation": "Contains information about a text query.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about a query to submit to the reranker model.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RerankQueryContentType": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEXT" } } } }, "com.amazonaws.bedrockagentruntime#RerankRequest": { "type": "structure", "members": { "queries": { "target": "com.amazonaws.bedrockagentruntime#RerankQueriesList", "traits": { "smithy.api#documentation": "An array of objects, each of which contains information about a query to submit to the reranker model.
", "smithy.api#required": {} } }, "sources": { "target": "com.amazonaws.bedrockagentruntime#RerankSourcesList", "traits": { "smithy.api#documentation": "An array of objects, each of which contains information about the sources to rerank.
", "smithy.api#required": {} } }, "rerankingConfiguration": { "target": "com.amazonaws.bedrockagentruntime#RerankingConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for reranking.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#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 the results of reranking.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#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.
The original index of the document from the input sources array.
", "smithy.api#range": { "min": 0, "max": 1000 }, "smithy.api#required": {} } }, "relevanceScore": { "target": "smithy.api#Float", "traits": { "smithy.api#documentation": "The relevance score of the document.
", "smithy.api#required": {} } }, "document": { "target": "com.amazonaws.bedrockagentruntime#RerankDocument", "traits": { "smithy.api#documentation": "Contains information about the document.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a document that was reranked.
" } }, "com.amazonaws.bedrockagentruntime#RerankResultsList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#RerankResult" } }, "com.amazonaws.bedrockagentruntime#RerankSource": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#RerankSourceType", "traits": { "smithy.api#documentation": "The type of the source.
", "smithy.api#required": {} } }, "inlineDocumentSource": { "target": "com.amazonaws.bedrockagentruntime#RerankDocument", "traits": { "smithy.api#documentation": "Contains an inline definition of a source for reranking.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about a source for reranking.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RerankSourceType": { "type": "enum", "members": { "INLINE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INLINE" } } } }, "com.amazonaws.bedrockagentruntime#RerankSourcesList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#RerankSource" }, "traits": { "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RerankTextDocument": { "type": "structure", "members": { "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The text of the document.
", "smithy.api#length": { "min": 1, "max": 32000 } } } }, "traits": { "smithy.api#documentation": "Contains information about a text document to rerank.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RerankingConfiguration": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#RerankingConfigurationType", "traits": { "smithy.api#documentation": "The type of reranker that the configurations apply to.
", "smithy.api#required": {} } }, "bedrockRerankingConfiguration": { "target": "com.amazonaws.bedrockagentruntime#BedrockRerankingConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for an Amazon Bedrock reranker.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains configurations for reranking.
" } }, "com.amazonaws.bedrockagentruntime#RerankingConfigurationType": { "type": "enum", "members": { "BEDROCK_RERANKING_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" } } } }, "com.amazonaws.bedrockagentruntime#RerankingMetadataSelectionMode": { "type": "enum", "members": { "SELECTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELECTIVE" } }, "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } } } }, "com.amazonaws.bedrockagentruntime#RerankingMetadataSelectiveModeConfiguration": { "type": "union", "members": { "fieldsToInclude": { "target": "com.amazonaws.bedrockagentruntime#FieldsForReranking", "traits": { "smithy.api#documentation": "An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
" } }, "fieldsToExclude": { "target": "com.amazonaws.bedrockagentruntime#FieldsForReranking", "traits": { "smithy.api#documentation": "An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
" } } }, "traits": { "smithy.api#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.
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.bedrockagentruntime#ResponseBody": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "com.amazonaws.bedrockagentruntime#ContentBody" } }, "com.amazonaws.bedrockagentruntime#ResponseState": { "type": "enum", "members": { "FAILURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILURE" } }, "REPROMPT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPROMPT" } } } }, "com.amazonaws.bedrockagentruntime#ResponseStream": { "type": "union", "members": { "chunk": { "target": "com.amazonaws.bedrockagentruntime#PayloadPart", "traits": { "smithy.api#documentation": "Contains a part of an agent response and citations for it.
" } }, "trace": { "target": "com.amazonaws.bedrockagentruntime#TracePart", "traits": { "smithy.api#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.
" } }, "returnControl": { "target": "com.amazonaws.bedrockagentruntime#ReturnControlPayload", "traits": { "smithy.api#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.
" } }, "internalServerException": { "target": "com.amazonaws.bedrockagentruntime#InternalServerException", "traits": { "smithy.api#documentation": "An internal server error occurred. Retry your request.
" } }, "validationException": { "target": "com.amazonaws.bedrockagentruntime#ValidationException", "traits": { "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
" } }, "resourceNotFoundException": { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", "traits": { "smithy.api#documentation": "The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
" } }, "serviceQuotaExceededException": { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", "traits": { "smithy.api#documentation": "The number of requests exceeds the service quota. Resubmit your request later.
" } }, "throttlingException": { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", "traits": { "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
" } }, "accessDeniedException": { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", "traits": { "smithy.api#documentation": "The request is denied because of missing access permissions. Check your permissions and retry your request.
" } }, "conflictException": { "target": "com.amazonaws.bedrockagentruntime#ConflictException", "traits": { "smithy.api#documentation": "There was a conflict performing an operation. Resolve the conflict and retry your request.
" } }, "dependencyFailedException": { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", "traits": { "smithy.api#documentation": "There was an issue with a dependency. Check the resource configurations and retry the request.
" } }, "badGatewayException": { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", "traits": { "smithy.api#documentation": "There was an issue with a dependency due to a server issue. Retry your request.
" } }, "modelNotReadyException": { "target": "com.amazonaws.bedrockagentruntime#ModelNotReadyException", "traits": { "smithy.api#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.
" } }, "files": { "target": "com.amazonaws.bedrockagentruntime#FilePart", "traits": { "smithy.api#documentation": "Contains intermediate response for code interpreter if any files have been generated.
" } } }, "traits": { "smithy.api#documentation": "The response from invoking the agent and associated citations and trace information.
", "smithy.api#streaming": {} } }, "com.amazonaws.bedrockagentruntime#RetrievalContent": { "type": "structure", "members": { "byteContent": { "target": "smithy.api#Blob", "traits": { "smithy.api#documentation": "The binary content of the retrieved item.
" } }, "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The text content of the retrieved item.
" } }, "mimeType": { "target": "com.amazonaws.bedrockagentruntime#MimeType", "traits": { "smithy.api#documentation": "The MIME type of the retrieved content.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The content retrieved from a knowledge source.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalFilter": { "type": "union", "members": { "equals": { "target": "com.amazonaws.bedrockagentruntime#FilterAttribute", "traits": { "smithy.api#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 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 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 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 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 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 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 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 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\" }
Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
" } }, "orAll": { "target": "com.amazonaws.bedrockagentruntime#RetrievalFilterList", "traits": { "smithy.api#documentation": "Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
" } } }, "traits": { "smithy.api#documentation": "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 \u2013 in the filter field
RetrieveAndGenerate request \u2013 in the filter field
The identifier of a retrieval instruction resource.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z0-9]+$" } }, "com.amazonaws.bedrockagentruntime#RetrievalInstructionVersion": { "type": "string", "traits": { "smithy.api#documentation": "A retrieval instruction version selector: a version number, or DRAFT.
", "smithy.api#length": { "min": 1, "max": 9 }, "smithy.api#pattern": "^(DRAFT|[1-9][0-9]{0,8})$" } }, "com.amazonaws.bedrockagentruntime#RetrievalOverrides": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.bedrockagentruntime#RetrievalFilter", "traits": { "smithy.api#documentation": "A filter to apply to the retrieval results.
" } }, "maxNumberOfResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of results to return.
", "smithy.api#range": { "min": 1 } } } }, "traits": { "smithy.api#documentation": "Overrides for retrieval behavior.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalResultConfluenceLocation": { "type": "structure", "members": { "url": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Confluence host URL for the data source location.
" } } }, "traits": { "smithy.api#documentation": "The Confluence data source location.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalResultContent": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContentType", "traits": { "smithy.api#documentation": "The type of content in the retrieval result.
" } }, "text": { "target": "smithy.api#String", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "The cited text from the data source.
" } }, "byteContent": { "target": "smithy.api#String", "traits": { "smithy.api#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}.
Video segment information when the retrieval result contains video content.
" } }, "audio": { "target": "com.amazonaws.bedrockagentruntime#AudioSegment", "traits": { "smithy.api#documentation": "Audio segment information when the retrieval result contains audio content.
" } }, "row": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContentRow", "traits": { "smithy.api#documentation": "Specifies information about the rows with the cells to return in retrieval.
" } } }, "traits": { "smithy.api#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 \u2013 in the content field
RetrieveAndGenerate response \u2013 in the content field
InvokeAgent response \u2013 in the content field
The name of the column.
" } }, "columnValue": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The value in the column.
" } }, "type": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContentColumnType", "traits": { "smithy.api#documentation": "The data type of the value.
" } } }, "traits": { "smithy.api#documentation": "Contains information about a column with a cell to return in retrieval.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RetrievalResultContentColumnType": { "type": "enum", "members": { "BLOB": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BLOB" } }, "BOOLEAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BOOLEAN" } }, "DOUBLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DOUBLE" } }, "NULL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NULL" } }, "LONG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LONG" } }, "STRING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STRING" } } } }, "com.amazonaws.bedrockagentruntime#RetrievalResultContentRow": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultContentColumn" }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RetrievalResultContentType": { "type": "enum", "members": { "TEXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEXT" } }, "IMAGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMAGE" } }, "ROW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROW" } }, "AUDIO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUDIO" } }, "VIDEO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VIDEO" } } } }, "com.amazonaws.bedrockagentruntime#RetrievalResultCustomDocumentLocation": { "type": "structure", "members": { "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The ID of the document.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the location of a document in a custom data source.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalResultGoogleDriveLocation": { "type": "structure", "members": { "url": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Google Drive URL for the data source location.
" } } }, "traits": { "smithy.api#documentation": "The Google Drive location of a retrieval result.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalResultKendraDocumentLocation": { "type": "structure", "members": { "uri": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The document's uri.
" } } }, "traits": { "smithy.api#documentation": "The location of a result in Amazon Kendra.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalResultLocation": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocationType", "traits": { "smithy.api#documentation": "The type of data source location.
", "smithy.api#required": {} } }, "s3Location": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location", "traits": { "smithy.api#documentation": "The S3 data source location.
" } }, "webLocation": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultWebLocation", "traits": { "smithy.api#documentation": "The web URL/URLs data source location.
" } }, "confluenceLocation": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultConfluenceLocation", "traits": { "smithy.api#documentation": "The Confluence data source location.
" } }, "salesforceLocation": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultSalesforceLocation", "traits": { "smithy.api#documentation": "The Salesforce data source location.
" } }, "sharePointLocation": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultSharePointLocation", "traits": { "smithy.api#documentation": "The SharePoint data source location.
" } }, "customDocumentLocation": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultCustomDocumentLocation", "traits": { "smithy.api#documentation": "Specifies the location of a document in a custom data source.
" } }, "kendraDocumentLocation": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultKendraDocumentLocation", "traits": { "smithy.api#documentation": "The location of a document in Amazon Kendra.
" } }, "sqlLocation": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultSqlLocation", "traits": { "smithy.api#documentation": "Specifies information about the SQL query used to retrieve the result.
" } }, "oneDriveLocation": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultOneDriveLocation", "traits": { "smithy.api#documentation": "The Microsoft OneDrive data source location.
" } }, "googleDriveLocation": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultGoogleDriveLocation", "traits": { "smithy.api#documentation": "The Google Drive data source location.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the data source location.
This data type is used in the following API operations:
Retrieve response \u2013 in the location field
RetrieveAndGenerate response \u2013 in the location field
InvokeAgent response \u2013 in the location field
The OneDrive URL for the data source location.
" } } }, "traits": { "smithy.api#documentation": "The Microsoft OneDrive location of a retrieval result.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalResultS3Location": { "type": "structure", "members": { "uri": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The S3 URI for the data source location.
" } } }, "traits": { "smithy.api#documentation": "The S3 data source location.
This data type is used in the following API operations:
Retrieve response \u2013 in the s3Location field
RetrieveAndGenerate response \u2013 in the s3Location field
InvokeAgent response \u2013 in the s3Location field
The Salesforce host URL for the data source location.
" } } }, "traits": { "smithy.api#documentation": "The Salesforce data source location.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalResultSharePointLocation": { "type": "structure", "members": { "url": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The SharePoint site URL for the data source location.
" } } }, "traits": { "smithy.api#documentation": "The SharePoint data source location.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalResultSqlLocation": { "type": "structure", "members": { "query": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The SQL query used to retrieve the result.
" } } }, "traits": { "smithy.api#documentation": "Contains information about the SQL query used to retrieve the result.
" } }, "com.amazonaws.bedrockagentruntime#RetrievalResultWebLocation": { "type": "structure", "members": { "url": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The web URL/URLs for the data source location.
" } } }, "traits": { "smithy.api#documentation": "The web URL/URLs data source location.
" } }, "com.amazonaws.bedrockagentruntime#Retrieve": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#RetrieveRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#RetrieveResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Queries a knowledge base and retrieves information from it.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/knowledgebases/{knowledgeBaseId}/retrieve" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "retrievalResults" }, "smithy.api#readonly": {} } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerate": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#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.
This API cannot be used with managed knowledge bases. Use AgenticRetrieveStream or Retrieve with managed knowledge bases.
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 knowledge base for retrieving information and generating responses.
" } }, "externalSourcesConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ExternalSourcesRetrieveAndGenerateConfiguration", "traits": { "smithy.api#documentation": "The configuration for the external source wrapper object in the retrieveAndGenerate function.
Contains details about the resource being queried.
This data type is used in the following API operations:
RetrieveAndGenerate request \u2013 in the retrieveAndGenerateConfiguration field
The query made to the knowledge base, in characters.
", "smithy.api#length": { "max": 1000 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the query made to the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request \u2013 in the input field
The response generated from querying the knowledge base.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains the response generated from querying the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate response \u2013 in the output field
A text response.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A retrieve and generate output event.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateRequest": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#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.
Contains the query to be made to the knowledge base.
", "smithy.api#required": {} } }, "retrieveAndGenerateConfiguration": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" } }, "sessionConfiguration": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration", "traits": { "smithy.api#documentation": "Contains details about the session with the knowledge base.
" } }, "userContext": { "target": "com.amazonaws.bedrockagentruntime#UserContext", "traits": { "smithy.api#documentation": "Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerate" } ] }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateResponse": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#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.
Contains the response generated from querying the knowledge base.
", "smithy.api#required": {} } }, "citations": { "target": "com.amazonaws.bedrockagentruntime#Citations", "traits": { "smithy.api#documentation": "A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
" } }, "guardrailAction": { "target": "com.amazonaws.bedrockagentruntime#GuadrailAction", "traits": { "smithy.api#documentation": "Specifies if there is a guardrail intervention in the response.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration": { "type": "structure", "members": { "kmsKeyArn": { "target": "com.amazonaws.bedrockagentruntime#KmsKeyArn", "traits": { "smithy.api#documentation": "The ARN of the KMS key encrypting the session.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains configuration about the session with the knowledge base.
This data type is used in the following API operations:
RetrieveAndGenerate request \u2013 in the sessionConfiguration field
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
This API cannot be used with managed knowledge bases. Use AgenticRetrieveStream or Retrieve with managed knowledge bases.
The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.
This operation requires permission for the bedrock:RetrieveAndGenerate action.
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.
Contains the query to be made to the knowledge base.
", "smithy.api#required": {} } }, "retrieveAndGenerateConfiguration": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" } }, "sessionConfiguration": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateSessionConfiguration", "traits": { "smithy.api#documentation": "Contains details about the session with the knowledge base.
" } }, "userContext": { "target": "com.amazonaws.bedrockagentruntime#UserContext", "traits": { "smithy.api#documentation": "Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStream" } ] }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResponse": { "type": "structure", "members": { "stream": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResponseOutput", "traits": { "smithy.api#documentation": "A stream of events from the model.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#documentation": "The session ID.
", "smithy.api#httpHeader": "x-amzn-bedrock-knowledge-base-session-id", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateStreamResponseOutput": { "type": "union", "members": { "output": { "target": "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateOutputEvent", "traits": { "smithy.api#documentation": "An output event.
" } }, "citation": { "target": "com.amazonaws.bedrockagentruntime#CitationEvent", "traits": { "smithy.api#documentation": "A citation event.
" } }, "guardrail": { "target": "com.amazonaws.bedrockagentruntime#GuardrailEvent", "traits": { "smithy.api#documentation": "A guardrail event.
" } }, "internalServerException": { "target": "com.amazonaws.bedrockagentruntime#InternalServerException", "traits": { "smithy.api#documentation": "An internal server error occurred. Retry your request.
" } }, "validationException": { "target": "com.amazonaws.bedrockagentruntime#ValidationException", "traits": { "smithy.api#documentation": "The input fails to satisfy the constraints specified by Amazon Bedrock. For troubleshooting this error, see ValidationError in the Amazon Bedrock User Guide.
" } }, "resourceNotFoundException": { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException", "traits": { "smithy.api#documentation": "The specified resource ARN was not found. For troubleshooting this error, see ResourceNotFound in the Amazon Bedrock User Guide.
" } }, "serviceQuotaExceededException": { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException", "traits": { "smithy.api#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": { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException", "traits": { "smithy.api#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.
" } }, "accessDeniedException": { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException", "traits": { "smithy.api#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.
" } }, "conflictException": { "target": "com.amazonaws.bedrockagentruntime#ConflictException", "traits": { "smithy.api#documentation": "Error occurred because of a conflict while performing an operation.
" } }, "dependencyFailedException": { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException", "traits": { "smithy.api#documentation": "The request failed due to a dependency error.
" } }, "badGatewayException": { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException", "traits": { "smithy.api#documentation": "The request failed due to a bad gateway error.
" } } }, "traits": { "smithy.api#documentation": "A retrieve and generate stream response output.
", "smithy.api#streaming": {} } }, "com.amazonaws.bedrockagentruntime#RetrieveAndGenerateType": { "type": "enum", "members": { "KNOWLEDGE_BASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KNOWLEDGE_BASE" } }, "EXTERNAL_SOURCES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXTERNAL_SOURCES" } } } }, "com.amazonaws.bedrockagentruntime#RetrieveRequest": { "type": "structure", "members": { "knowledgeBaseId": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the knowledge base to query.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "retrievalQuery": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseQuery", "traits": { "smithy.api#documentation": "Contains the query to send the knowledge base.
", "smithy.api#required": {} } }, "retrievalConfiguration": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
" } }, "guardrailConfiguration": { "target": "com.amazonaws.bedrockagentruntime#GuardrailConfiguration", "traits": { "smithy.api#documentation": "Guardrail settings.
" } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#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 information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#RetrieveResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#Retrieve" } ] }, "com.amazonaws.bedrockagentruntime#RetrieveResponse": { "type": "structure", "members": { "retrievalResults": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseRetrievalResults", "traits": { "smithy.api#documentation": "A list of results from querying the knowledge base.
", "smithy.api#required": {} } }, "guardrailAction": { "target": "com.amazonaws.bedrockagentruntime#GuadrailAction", "traits": { "smithy.api#documentation": "Specifies if there is a guardrail intervention in the response.
" } }, "nextToken": { "target": "com.amazonaws.bedrockagentruntime#NextToken", "traits": { "smithy.api#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 the cited text from the data source.
" } }, "location": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultLocation", "traits": { "smithy.api#documentation": "Contains information about the location of the data source.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#RetrievalResultMetadata", "traits": { "smithy.api#documentation": "Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.
" } } }, "traits": { "smithy.api#documentation": "Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
RetrieveAndGenerate response \u2013 in the retrievedReferences field
InvokeAgent response \u2013 in the retrievedReferences field
Configuration for a knowledge base retriever.
" } } }, "traits": { "smithy.api#documentation": "Configuration for a retriever, specified as a union of retriever types.
" } }, "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#InvocationResultMember" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.bedrockagentruntime#ReturnControlPayload": { "type": "structure", "members": { "invocationInputs": { "target": "com.amazonaws.bedrockagentruntime#InvocationInputs", "traits": { "smithy.api#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.
" } }, "invocationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the action group invocation.
" } } }, "traits": { "smithy.api#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:
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#ReturnControlResults": { "type": "structure", "members": { "invocationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The action's invocation ID.
" } }, "returnControlInvocationResults": { "target": "com.amazonaws.bedrockagentruntime#ReturnControlInvocationResults", "traits": { "smithy.api#documentation": "The action invocation result.
" } } }, "traits": { "smithy.api#documentation": "An action invocation result.
" } }, "com.amazonaws.bedrockagentruntime#RoutingClassifierModelInvocationOutput": { "type": "structure", "members": { "traceId": { "target": "com.amazonaws.bedrockagentruntime#TraceId", "traits": { "smithy.api#documentation": "The invocation's trace ID.
" } }, "rawResponse": { "target": "com.amazonaws.bedrockagentruntime#RawResponse", "traits": { "smithy.api#documentation": "The invocation's raw response.
" } }, "metadata": { "target": "com.amazonaws.bedrockagentruntime#Metadata", "traits": { "smithy.api#documentation": "The invocation's metadata.
" } } }, "traits": { "smithy.api#documentation": "Invocation output from a routing classifier model.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#RoutingClassifierTrace": { "type": "union", "members": { "invocationInput": { "target": "com.amazonaws.bedrockagentruntime#InvocationInput", "traits": { "smithy.api#documentation": "The classifier's invocation input.
" } }, "observation": { "target": "com.amazonaws.bedrockagentruntime#Observation", "traits": { "smithy.api#documentation": "The classifier's observation.
" } }, "modelInvocationInput": { "target": "com.amazonaws.bedrockagentruntime#ModelInvocationInput", "traits": { "smithy.api#documentation": "The classifier's model invocation input.
" } }, "modelInvocationOutput": { "target": "com.amazonaws.bedrockagentruntime#RoutingClassifierModelInvocationOutput", "traits": { "smithy.api#documentation": "The classifier's model invocation output.
" } } }, "traits": { "smithy.api#documentation": "A trace for a routing classifier.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#S3BucketName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 63 }, "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" } }, "com.amazonaws.bedrockagentruntime#S3Identifier": { "type": "structure", "members": { "s3BucketName": { "target": "com.amazonaws.bedrockagentruntime#S3BucketName", "traits": { "smithy.api#documentation": "The name of the S3 bucket.
" } }, "s3ObjectKey": { "target": "com.amazonaws.bedrockagentruntime#S3ObjectKey", "traits": { "smithy.api#documentation": "The S3 object key for the S3 resource.
" } } }, "traits": { "smithy.api#documentation": "The identifier information for an Amazon S3 bucket.
" } }, "com.amazonaws.bedrockagentruntime#S3Location": { "type": "structure", "members": { "uri": { "target": "com.amazonaws.bedrockagentruntime#S3Uri", "traits": { "smithy.api#documentation": "The path to the Amazon S3 bucket where the image is stored.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Information about the Amazon S3 bucket where the image is stored.
" } }, "com.amazonaws.bedrockagentruntime#S3ObjectDoc": { "type": "structure", "members": { "uri": { "target": "com.amazonaws.bedrockagentruntime#S3Uri", "traits": { "smithy.api#documentation": "The file location of the S3 wrapper object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The unique wrapper object of the document from the S3 location.
" } }, "com.amazonaws.bedrockagentruntime#S3ObjectFile": { "type": "structure", "members": { "uri": { "target": "com.amazonaws.bedrockagentruntime#S3Uri", "traits": { "smithy.api#documentation": "The uri of the s3 object.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains details of the s3 object where the source file is located.
" } }, "com.amazonaws.bedrockagentruntime#S3ObjectKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" } }, "com.amazonaws.bedrockagentruntime#S3Uri": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 }, "smithy.api#pattern": "^s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}$" } }, "com.amazonaws.bedrockagentruntime#SatisfiedCondition": { "type": "structure", "members": { "conditionName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the condition that was satisfied.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#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.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.bedrockagentruntime#SessionArn": { "type": "string", "traits": { "smithy.api#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}$" } }, "com.amazonaws.bedrockagentruntime#SessionAttributesMap": { "type": "map", "key": { "target": "smithy.api#String" }, "value": { "target": "smithy.api#String" } }, "com.amazonaws.bedrockagentruntime#SessionId": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 100 }, "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" } }, "com.amazonaws.bedrockagentruntime#SessionIdentifier": { "type": "string", "traits": { "smithy.api#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})$" } }, "com.amazonaws.bedrockagentruntime#SessionMetadataKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.bedrockagentruntime#SessionMetadataMap": { "type": "map", "key": { "target": "com.amazonaws.bedrockagentruntime#SessionMetadataKey" }, "value": { "target": "com.amazonaws.bedrockagentruntime#SessionMetadataValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.bedrockagentruntime#SessionMetadataValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 5000 } } }, "com.amazonaws.bedrockagentruntime#SessionResource": { "type": "resource", "identifiers": { "sessionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier" } }, "create": { "target": "com.amazonaws.bedrockagentruntime#CreateSession" }, "read": { "target": "com.amazonaws.bedrockagentruntime#GetSession" }, "update": { "target": "com.amazonaws.bedrockagentruntime#UpdateSession" }, "delete": { "target": "com.amazonaws.bedrockagentruntime#DeleteSession" }, "list": { "target": "com.amazonaws.bedrockagentruntime#ListSessions" }, "operations": [ { "target": "com.amazonaws.bedrockagentruntime#EndSession" } ], "resources": [ { "target": "com.amazonaws.bedrockagentruntime#InvocationResource" }, { "target": "com.amazonaws.bedrockagentruntime#InvocationStepResource" } ] }, "com.amazonaws.bedrockagentruntime#SessionState": { "type": "structure", "members": { "sessionAttributes": { "target": "com.amazonaws.bedrockagentruntime#SessionAttributesMap", "traits": { "smithy.api#documentation": "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 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.
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.
Contains information about the files used by code interpreter.
" } }, "knowledgeBaseConfigurations": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseConfigurations", "traits": { "smithy.api#documentation": "An array of configurations, each of which applies to a knowledge base attached to the agent.
" } }, "conversationHistory": { "target": "com.amazonaws.bedrockagentruntime#ConversationHistory", "traits": { "smithy.api#documentation": "The state's conversation history.
" } } }, "traits": { "smithy.api#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 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.
" } }, "com.amazonaws.bedrockagentruntime#SessionStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "ENDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENDED" } } } }, "com.amazonaws.bedrockagentruntime#SessionSummaries": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#SessionSummary" } }, "com.amazonaws.bedrockagentruntime#SessionSummary": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.bedrockagentruntime#Uuid", "traits": { "smithy.api#documentation": "The unique identifier for the session.
", "smithy.api#required": {} } }, "sessionArn": { "target": "com.amazonaws.bedrockagentruntime#SessionArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session.
", "smithy.api#required": {} } }, "sessionStatus": { "target": "com.amazonaws.bedrockagentruntime#SessionStatus", "traits": { "smithy.api#documentation": "The current status of the session.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the session was created.
", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the session was last modified.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains details about a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
" } }, "com.amazonaws.bedrockagentruntime#SessionTTL": { "type": "integer", "traits": { "smithy.api#range": { "min": 60, "max": 3600 } } }, "com.amazonaws.bedrockagentruntime#Source": { "type": "enum", "members": { "ACTION_GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_GROUP" } }, "KNOWLEDGE_BASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KNOWLEDGE_BASE" } }, "PARSER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARSER" } } }, "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#Span": { "type": "structure", "members": { "start": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Where the text with a citation starts in the generated output.
", "smithy.api#range": { "min": 0 } } }, "end": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Where the text with a citation ends in the generated output.
", "smithy.api#range": { "min": 0 } } } }, "traits": { "smithy.api#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 \u2013 in the span field
InvokeAgent response \u2013 in the span field
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.
The unique identifier of the flow to execute.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias to use for the flow execution.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "flowExecutionName": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionName", "traits": { "smithy.api#documentation": "The unique name for the flow execution. If you don't provide one, a system-generated name is used.
" } }, "inputs": { "target": "com.amazonaws.bedrockagentruntime#FlowInputs", "traits": { "smithy.api#documentation": "The input data required for the flow execution. This must match the input schema defined in the flow.
", "smithy.api#required": {} } }, "modelPerformanceConfiguration": { "target": "com.amazonaws.bedrockagentruntime#ModelPerformanceConfiguration", "traits": { "smithy.api#documentation": "The performance settings for the foundation model used in the flow execution.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#StartFlowExecutionResponse": { "type": "structure", "members": { "executionArn": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#StopFlowExecution": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#StopFlowExecutionRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#StopFlowExecutionResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#BadGatewayException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#DependencyFailedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to Aborted.
The unique identifier of the flow.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "flowAliasIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowAliasIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow alias used for the execution.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "executionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the flow execution to stop.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#StopFlowExecutionResponse": { "type": "structure", "members": { "executionArn": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionIdentifier", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that uniquely identifies the flow execution that was stopped.
" } }, "status": { "target": "com.amazonaws.bedrockagentruntime#FlowExecutionStatus", "traits": { "smithy.api#documentation": "The updated status of the flow execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#StopSequences": { "type": "list", "member": { "target": "smithy.api#String" }, "traits": { "smithy.api#length": { "min": 0, "max": 4 } } }, "com.amazonaws.bedrockagentruntime#StreamingConfigurations": { "type": "structure", "members": { "streamFinalResponse": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": " Specifies whether to enable streaming for the final response. This is set to false by default.
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
Configurations for streaming.
" } }, "com.amazonaws.bedrockagentruntime#SummaryText": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 25000000 } } }, "com.amazonaws.bedrockagentruntime#TagKey": { "type": "string", "traits": { "smithy.api#documentation": "Key of a tag", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" } }, "com.amazonaws.bedrockagentruntime#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagentruntime#TagKey" }, "traits": { "smithy.api#documentation": "List of Tag Keys", "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.bedrockagentruntime#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#TagResourceRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ServiceQuotaExceededException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/tags/{resourceArn}" } } }, "com.amazonaws.bedrockagentruntime#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.bedrockagentruntime#TaggableResourcesArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to tag.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.bedrockagentruntime#TagsMap", "traits": { "smithy.api#documentation": "An object containing key-value pairs that define the tags to attach to the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#TagValue": { "type": "string", "traits": { "smithy.api#documentation": "Value of a tag", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9\\s._:/=+@-]*$" } }, "com.amazonaws.bedrockagentruntime#TaggableResourcesArn": { "type": "string", "traits": { "smithy.api#documentation": "ARN of Taggable resources: [session]", "smithy.api#length": { "min": 20, "max": 1011 }, "smithy.api#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}$)" } }, "com.amazonaws.bedrockagentruntime#TaggingResource": { "type": "resource", "operations": [ { "target": "com.amazonaws.bedrockagentruntime#ListTagsForResource" }, { "target": "com.amazonaws.bedrockagentruntime#TagResource" }, { "target": "com.amazonaws.bedrockagentruntime#UntagResource" } ] }, "com.amazonaws.bedrockagentruntime#TagsMap": { "type": "map", "key": { "target": "com.amazonaws.bedrockagentruntime#TagKey" }, "value": { "target": "com.amazonaws.bedrockagentruntime#TagValue" }, "traits": { "smithy.api#documentation": "A map of tag keys and values", "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.bedrockagentruntime#Temperature": { "type": "float", "traits": { "smithy.api#range": { "min": 0, "max": 1 } } }, "com.amazonaws.bedrockagentruntime#TextInferenceConfig": { "type": "structure", "members": { "temperature": { "target": "com.amazonaws.bedrockagentruntime#Temperature", "traits": { "smithy.api#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": { "target": "com.amazonaws.bedrockagentruntime#TopP", "traits": { "smithy.api#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.
" } }, "maxTokens": { "target": "com.amazonaws.bedrockagentruntime#MaxTokens", "traits": { "smithy.api#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": { "target": "com.amazonaws.bedrockagentruntime#RAGStopSequences", "traits": { "smithy.api#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.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#length": { "min": 1, "max": 200000 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about the text prompt to optimize.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#TextPromptTemplate": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4000 }, "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#TextResponsePart": { "type": "structure", "members": { "text": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The part of the generated text that contains a citation.
" } }, "span": { "target": "com.amazonaws.bedrockagentruntime#Span", "traits": { "smithy.api#documentation": "Contains information about where the text with a citation begins and ends in the generated output.
" } } }, "traits": { "smithy.api#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 \u2013 in the textResponsePart field
InvokeAgent response \u2013 in the textResponsePart field
The type of resource to use in transformation.
", "smithy.api#required": {} } }, "knowledgeBaseConfiguration": { "target": "com.amazonaws.bedrockagentruntime#TextToSqlKnowledgeBaseConfiguration", "traits": { "smithy.api#documentation": "Specifies configurations for a knowledge base to use in transformation.
" } } }, "traits": { "smithy.api#documentation": "Contains configurations for transforming text to SQL.
" } }, "com.amazonaws.bedrockagentruntime#TextToSqlConfigurationType": { "type": "enum", "members": { "KNOWLEDGE_BASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KNOWLEDGE_BASE" } } } }, "com.amazonaws.bedrockagentruntime#TextToSqlKnowledgeBaseConfiguration": { "type": "structure", "members": { "knowledgeBaseArn": { "target": "com.amazonaws.bedrockagentruntime#KnowledgeBaseArn", "traits": { "smithy.api#documentation": "The ARN of the knowledge base
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains configurations for a knowledge base to use in transformation.
" } }, "com.amazonaws.bedrockagentruntime#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.bedrockagentruntime#NonBlankString" } }, "traits": { "smithy.api#documentation": "The number of requests exceeds the limit. Resubmit your request later.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.bedrockagentruntime#TopK": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 500 } } }, "com.amazonaws.bedrockagentruntime#TopP": { "type": "float", "traits": { "smithy.api#range": { "min": 0, "max": 1 } } }, "com.amazonaws.bedrockagentruntime#Trace": { "type": "union", "members": { "guardrailTrace": { "target": "com.amazonaws.bedrockagentruntime#GuardrailTrace", "traits": { "smithy.api#documentation": "The trace details for a trace defined in the Guardrail filter.
" } }, "preProcessingTrace": { "target": "com.amazonaws.bedrockagentruntime#PreProcessingTrace", "traits": { "smithy.api#documentation": "Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
" } }, "orchestrationTrace": { "target": "com.amazonaws.bedrockagentruntime#OrchestrationTrace", "traits": { "smithy.api#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": { "target": "com.amazonaws.bedrockagentruntime#PostProcessingTrace", "traits": { "smithy.api#documentation": "Details about the post-processing step, in which the agent shapes the response..
" } }, "routingClassifierTrace": { "target": "com.amazonaws.bedrockagentruntime#RoutingClassifierTrace", "traits": { "smithy.api#documentation": "A routing classifier's trace.
" } }, "failureTrace": { "target": "com.amazonaws.bedrockagentruntime#FailureTrace", "traits": { "smithy.api#documentation": "Contains information about the failure of the interaction.
" } }, "customOrchestrationTrace": { "target": "com.amazonaws.bedrockagentruntime#CustomOrchestrationTrace", "traits": { "smithy.api#documentation": "Details about the custom orchestration step in which the agent determines the order in which actions are executed.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#TraceElements": { "type": "union", "members": { "agentTraces": { "target": "com.amazonaws.bedrockagentruntime#AgentTraces", "traits": { "smithy.api#documentation": "Agent trace information for the flow execution.
" } } }, "traits": { "smithy.api#documentation": "Contains trace elements for flow execution tracking.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#TraceId": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 16 } } }, "com.amazonaws.bedrockagentruntime#TraceKnowledgeBaseId": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#TracePart": { "type": "structure", "members": { "sessionId": { "target": "com.amazonaws.bedrockagentruntime#SessionId", "traits": { "smithy.api#documentation": "The unique identifier of the session with the agent.
" } }, "trace": { "target": "com.amazonaws.bedrockagentruntime#Trace", "traits": { "smithy.api#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.
" } }, "callerChain": { "target": "com.amazonaws.bedrockagentruntime#CallerChain", "traits": { "smithy.api#documentation": "The part's caller chain.
" } }, "eventTime": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The time of the trace.
", "smithy.api#timestampFormat": "date-time" } }, "collaboratorName": { "target": "com.amazonaws.bedrockagentruntime#Name", "traits": { "smithy.api#documentation": "The part's collaborator name.
" } }, "agentId": { "target": "com.amazonaws.bedrockagentruntime#AgentId", "traits": { "smithy.api#documentation": "The unique identifier of the agent.
" } }, "agentAliasId": { "target": "com.amazonaws.bedrockagentruntime#AgentAliasId", "traits": { "smithy.api#documentation": "The unique identifier of the alias of the agent.
" } }, "agentVersion": { "target": "com.amazonaws.bedrockagentruntime#AgentVersion", "traits": { "smithy.api#documentation": "The version of the agent.
" } } }, "traits": { "smithy.api#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.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#TransformationConfiguration": { "type": "structure", "members": { "mode": { "target": "com.amazonaws.bedrockagentruntime#QueryTransformationMode", "traits": { "smithy.api#documentation": "The mode of the transformation.
", "smithy.api#required": {} } }, "textToSqlConfiguration": { "target": "com.amazonaws.bedrockagentruntime#TextToSqlConfiguration", "traits": { "smithy.api#documentation": "Specifies configurations for transforming text to SQL.
" } } }, "traits": { "smithy.api#documentation": "Contains configurations for transforming the natural language query into SQL.
" } }, "com.amazonaws.bedrockagentruntime#Type": { "type": "enum", "members": { "ACTION_GROUP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_GROUP" } }, "AGENT_COLLABORATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGENT_COLLABORATOR" } }, "KNOWLEDGE_BASE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KNOWLEDGE_BASE" } }, "FINISH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FINISH" } }, "ASK_USER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASK_USER" } }, "REPROMPT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REPROMPT" } } } }, "com.amazonaws.bedrockagentruntime#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#UntagResourceRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#documentation": "Remove tags from a resource.
", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.bedrockagentruntime#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.bedrockagentruntime#TaggableResourcesArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to remove tags.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.bedrockagentruntime#TagKeyList", "traits": { "smithy.api#documentation": "A list of keys of the tags to remove from the resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.bedrockagentruntime#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#UpdateSession": { "type": "operation", "input": { "target": "com.amazonaws.bedrockagentruntime#UpdateSessionRequest" }, "output": { "target": "com.amazonaws.bedrockagentruntime#UpdateSessionResponse" }, "errors": [ { "target": "com.amazonaws.bedrockagentruntime#AccessDeniedException" }, { "target": "com.amazonaws.bedrockagentruntime#ConflictException" }, { "target": "com.amazonaws.bedrockagentruntime#InternalServerException" }, { "target": "com.amazonaws.bedrockagentruntime#ResourceNotFoundException" }, { "target": "com.amazonaws.bedrockagentruntime#ThrottlingException" }, { "target": "com.amazonaws.bedrockagentruntime#ValidationException" } ], "traits": { "smithy.api#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.
", "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/sessions/{sessionIdentifier}/" }, "smithy.api#idempotent": {} } }, "com.amazonaws.bedrockagentruntime#UpdateSessionRequest": { "type": "structure", "members": { "sessionMetadata": { "target": "com.amazonaws.bedrockagentruntime#SessionMetadataMap", "traits": { "smithy.api#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.
" } }, "sessionIdentifier": { "target": "com.amazonaws.bedrockagentruntime#SessionIdentifier", "traits": { "smithy.api#documentation": "The unique identifier of the session to modify. You can specify either the session's sessionId or its Amazon Resource Name (ARN).
The unique identifier of the session you updated.
", "smithy.api#required": {} } }, "sessionArn": { "target": "com.amazonaws.bedrockagentruntime#SessionArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the session that was updated.
", "smithy.api#required": {} } }, "sessionStatus": { "target": "com.amazonaws.bedrockagentruntime#SessionStatus", "traits": { "smithy.api#documentation": "The status of the session you updated.
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the session was created.
", "smithy.api#required": {} } }, "lastUpdatedAt": { "target": "com.amazonaws.bedrockagentruntime#DateTimestamp", "traits": { "smithy.api#documentation": "The timestamp for when the session was last modified.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.bedrockagentruntime#Usage": { "type": "structure", "members": { "inputTokens": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Contains information about the input tokens from the foundation model usage.
" } }, "outputTokens": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Contains information about the output tokens from the foundation model usage.
" } } }, "traits": { "smithy.api#documentation": "Contains information of the usage of the foundation model.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#UserContext": { "type": "structure", "members": { "userId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The identifier of the user making the retrieval request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Contains information about the user making the request. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.
", "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#Uuid": { "type": "string", "traits": { "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, "com.amazonaws.bedrockagentruntime#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.bedrockagentruntime#NonBlankString" } }, "traits": { "smithy.api#documentation": "Input validation failed. Check your request parameters and retry the request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.bedrockagentruntime#VectorSearchBedrockRerankingConfiguration": { "type": "structure", "members": { "modelConfiguration": { "target": "com.amazonaws.bedrockagentruntime#VectorSearchBedrockRerankingModelConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for the reranker model.
", "smithy.api#required": {} } }, "numberOfRerankedResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of results to return after reranking.
", "smithy.api#range": { "min": 1, "max": 100 } } }, "metadataConfiguration": { "target": "com.amazonaws.bedrockagentruntime#MetadataConfigurationForReranking", "traits": { "smithy.api#documentation": "Contains configurations for the metadata to use in reranking.
" } } }, "traits": { "smithy.api#documentation": "Contains configurations for reranking with an Amazon Bedrock reranker model.
" } }, "com.amazonaws.bedrockagentruntime#VectorSearchBedrockRerankingModelConfiguration": { "type": "structure", "members": { "modelArn": { "target": "com.amazonaws.bedrockagentruntime#BedrockRerankingModelArn", "traits": { "smithy.api#documentation": "The ARN of the reranker model to use.
", "smithy.api#required": {} } }, "additionalModelRequestFields": { "target": "com.amazonaws.bedrockagentruntime#AdditionalModelRequestFields", "traits": { "smithy.api#documentation": "A JSON object whose keys are request fields for the model and whose values are values for those fields.
" } } }, "traits": { "smithy.api#documentation": "Contains configurations for an Amazon Bedrock reranker model.
" } }, "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfiguration": { "type": "structure", "members": { "type": { "target": "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfigurationType", "traits": { "smithy.api#documentation": "The type of reranker model.
", "smithy.api#required": {} } }, "bedrockRerankingConfiguration": { "target": "com.amazonaws.bedrockagentruntime#VectorSearchBedrockRerankingConfiguration", "traits": { "smithy.api#documentation": "Contains configurations for an Amazon Bedrock reranker model.
" } } }, "traits": { "smithy.api#documentation": "Contains configurations for reranking the retrieved results.
" } }, "com.amazonaws.bedrockagentruntime#VectorSearchRerankingConfigurationType": { "type": "enum", "members": { "BEDROCK_RERANKING_MODEL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEDROCK_RERANKING_MODEL" } } } }, "com.amazonaws.bedrockagentruntime#Verb": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.bedrockagentruntime#Version": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 5 }, "smithy.api#pattern": "^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$" } }, "com.amazonaws.bedrockagentruntime#VideoSegment": { "type": "structure", "members": { "s3Uri": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The S3 URI where this specific video segment is stored in the multimodal storage destination.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "summary": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A text summary describing the content of the video segment.
" } } }, "traits": { "smithy.api#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 \u2013 in the video field