View a markdown version of this page

ToolArguments - Amazon Bedrock AgentCore Data Plane
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).

ToolArguments

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.

Contents

clearContext

Whether to clear the context for the tool.

Type: Boolean

Required: No

code

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100000000.

Required: No

command

The command to execute with the tool.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100000000.

Required: No

content

The content for the tool operation.

Type: Array of InputContentBlock objects

Required: No

directoryPath

The directory path for the tool operation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100000000.

Required: No

language

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

Type: String

Valid Values: python | javascript | typescript

Required: No

path

The path for the tool operation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100000000.

Required: No

paths

The paths for the tool operation.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 100000000.

Required: No

runtime

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

Type: String

Valid Values: nodejs | deno | python

Required: No

taskId

The identifier of the task for the tool operation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100000000.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: