interface ToolSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnPromptPropsMixin.ToolSpecificationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnPromptPropsMixin_ToolSpecificationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnPromptPropsMixin.ToolSpecificationProperty`
Python	`aws_cdk.mixins_preview.aws_bedrock.mixins.CfnPromptPropsMixin.ToolSpecificationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_bedrock` » `mixins` » `CfnPromptPropsMixin` » `ToolSpecificationProperty`

The specification for the tool.

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

Example

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

declare const json: any;
const toolSpecificationProperty: bedrock_mixins.CfnPromptPropsMixin.ToolSpecificationProperty = {
  description: 'description',
  inputSchema: {
    json: json,
  },
  name: 'name',
};

Properties

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

description?

Type: string (optional)

The description for the tool.

inputSchema?

Type: IResolvable | ToolInputSchemaProperty (optional)

The input schema for the tool in JSON format.

name?