AWS::Wisdom::AIAgent ToolConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Wisdom::AIAgent ToolConfiguration

Configuration settings for a tool used by AI Agents.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Annotations" : Json,
  "Description" : String,
  "InputSchema" : Json,
  "Instruction" : ToolInstruction,
  "OutputFilters" : [ ToolOutputFilter, ... ],
  "OutputSchema" : Json,
  "OverrideInputValues" : [ ToolOverrideInputValue, ... ],
  "Title" : String,
  "ToolId" : String,
  "ToolName" : String,
  "ToolType" : String,
  "UserInteractionConfiguration" : UserInteractionConfiguration
}

Properties

Annotations

Annotations for the tool configuration.

Required: No

Type: Json

Update requires: No interruption

Description

The description of the tool configuration.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

InputSchema

The input schema for the tool configuration.

Required: No

Type: Json

Update requires: No interruption

Instruction

Instructions for using the tool.

Required: No

Type: ToolInstruction

Update requires: No interruption

OutputFilters

Output filters applies to the tool result.

Required: No

Type: Array of ToolOutputFilter

Update requires: No interruption

OutputSchema

The output schema for the tool configuration.

Required: No

Type: Json

Update requires: No interruption

OverrideInputValues

Override input values for the tool configuration.

Required: No

Type: Array of ToolOverrideInputValue

Update requires: No interruption

Title

The title of the tool configuration.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

ToolId

The identifier of the tool, for example toolName from Model Context Provider server.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

ToolName

The name of the tool.

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption

ToolType

The type of the tool.

Required: Yes

Type: String

Allowed values: MODEL_CONTEXT_PROTOCOL | RETURN_TO_CONTROL | CONSTANT

Update requires: No interruption

UserInteractionConfiguration

Configuration for user interaction with the tool.

Required: No

Type: UserInteractionConfiguration

Update requires: No interruption