Bedrock Agentcore  >  Structures  >  ToolArguments

ToolArguments

Structure Class

ToolArguments dataclass

The collection of arguments that specify the operation to perform and its parameters when invoking a tool in Amazon Bedrock AgentCore. Different tools require different arguments, and this structure provides a flexible way to pass the appropriate arguments to each tool type.

Attributes

clear_context class-attribute instance-attribute

clear_context: bool | None = None

Whether to clear the context for the tool.

code class-attribute instance-attribute

code: str | None = None

The code to execute in a code interpreter session. This is the source code in the specified programming language that will be executed by the code interpreter.

command class-attribute instance-attribute

command: str | None = None

The command to execute with the tool.

content class-attribute instance-attribute

content: list[InputContentBlock] | None = None

The content for the tool operation.

directory_path class-attribute instance-attribute

directory_path: str | None = None

The directory path for the tool operation.

language class-attribute instance-attribute

language: ProgrammingLanguage | None = None

The programming language of the code to execute. This tells the code interpreter which language runtime to use for execution.

path class-attribute instance-attribute

path: str | None = None

The path for the tool operation.

paths class-attribute instance-attribute

paths: list[str] | None = None

The paths for the tool operation.

runtime class-attribute instance-attribute

runtime: LanguageRuntime | None = None

The runtime environment to use for code execution. If not specified, defaults to deno for JavaScript and TypeScript.

task_id class-attribute instance-attribute

task_id: str | None = None

The identifier of the task for the tool operation.