Skip to content
v2.278.0

ToolSpecificationProperty Struct ​

The specification for the tool.

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

Example ​

ts
// 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.CfnPromptVersion.ToolSpecificationProperty = {
  inputSchema: {
    json: json,
  },
  name: 'name',

  // the properties below are optional
  description: 'description',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

# json: Any

tool_specification_property = bedrock.CfnPromptVersion.ToolSpecificationProperty(
    input_schema=bedrock.CfnPromptVersion.ToolInputSchemaProperty(
        json=json
    ),
    name="name",

    # the properties below are optional
    description="description"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.*;

Object json;

ToolSpecificationProperty toolSpecificationProperty = ToolSpecificationProperty.builder()
        .inputSchema(ToolInputSchemaProperty.builder()
                .json(json)
                .build())
        .name("name")

        // the properties below are optional
        .description("description")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock;

var json;

var toolSpecificationProperty = new ToolSpecificationProperty {
    InputSchema = new ToolInputSchemaProperty {
        Json = json
    },
    Name = "name",

    // the properties below are optional
    Description = "description"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var json interface{}

toolSpecificationProperty := &ToolSpecificationProperty{
	InputSchema: &ToolInputSchemaProperty{
		Json: json,
	},
	Name: jsii.String("name"),

	// the properties below are optional
	Description: jsii.String("description"),
}

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
The description for the tool.
inputSchemaIResolvable | CfnPromptVersion.ToolInputSchemaPropertyinput_schematyping.Union[IResolvable, ToolInputSchemaProperty]inputSchemaIResolvableInputSchemaIResolvableInputSchemainterface{} required #
The input schema for the tool in JSON format.
namestringnamestrnameStringNamestringName*string required #
The name for the tool.