aws-cdk-lib.aws_bedrock.CfnPrompt.ToolSpecificationProperty

ToolSpecificationProperty Struct

The specification for the tool.

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

Source

Generated code

Type last changed

v2.174.0 · 4 Jan 2025

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

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

The description for the tool.

inputSchemaIResolvable | CfnPrompt.ToolInputSchemaPropertyinput_schematyping.Union[IResolvable, ToolInputSchemaProperty]inputSchemaIResolvableInputSchemaIResolvableInputSchemainterface{}required#

The input schema for the tool in JSON format.

namestringnamestrnameStringNamestringName*stringrequired#

The name for the tool.