AWS::Bedrock::PromptVersion ToolChoice - 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::Bedrock::PromptVersion ToolChoice

Determines which tools the model should request in a call to Converse or ConverseStream. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

Syntax

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

JSON

{
  "Any" : Json,
  "Auto" : Json,
  "Tool" : SpecificToolChoice
}

YAML

  Any: Json
  Auto: Json
  Tool: 
    SpecificToolChoice

Properties

Any

The model must request at least one tool (no text is generated).

Required: No

Type: Json

Update requires: No interruption

Auto

(Default). The Model automatically decides if a tool should be called or whether to generate text instead.

Required: No

Type: Json

Update requires: No interruption

Tool

The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.

Required: No

Type: SpecificToolChoice

Update requires: No interruption