interface ToolSpecificationProperty

Language	Type name
.NET	Amazon.CDK.aws_bedrock.CfnPrompt.ToolSpecificationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnPrompt_ToolSpecificationProperty
Java	software.amazon.awscdk.services.bedrock.CfnPrompt.ToolSpecificationProperty
Python	aws_cdk.aws_bedrock.CfnPrompt.ToolSpecificationProperty
TypeScript	aws-cdk-lib » aws_bedrock » CfnPrompt » ToolSpecificationProperty

The specification for the tool.

For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';

declare const json: any;
const toolSpecificationProperty: bedrock.CfnPrompt.ToolSpecificationProperty = {
  inputSchema: {
    json: json,
  },
  name: 'name',

  // the properties below are optional
  description: 'description',
};

Properties

Name	Type	Description
inputSchema	IResolvable | ToolInputSchemaProperty	The input schema for the tool in JSON format.
name	string	The name for the tool.
description?	string	The description for the tool.

---

inputSchema

Type: IResolvable | ToolInputSchemaProperty

The input schema for the tool in JSON format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html#cfn-bedrock-prompt-toolspecification-inputschema

---

name

Type: string

The name for the tool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html#cfn-bedrock-prompt-toolspecification-name

---

description?

Type: string (optional)

The description for the tool.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html#cfn-bedrock-prompt-toolspecification-description