interface SchemaDefinition 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.SchemaDefinition
Go	github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#SchemaDefinition
Java	software.amazon.awscdk.services.bedrock.agentcore.alpha.SchemaDefinition
Python	aws_cdk.aws_bedrock_agentcore_alpha.SchemaDefinition
TypeScript (source)	@aws-cdk/aws-bedrock-agentcore-alpha » SchemaDefinition

Schema definition for tool input/output.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';

declare const schemaDefinition_: bedrock_agentcore_alpha.SchemaDefinition;
const schemaDefinition: bedrock_agentcore_alpha.SchemaDefinition = {
  type: bedrock_agentcore_alpha.SchemaDefinitionType.STRING,

  // the properties below are optional
  description: 'description',
  items: schemaDefinition_,
  properties: {
    propertiesKey: schemaDefinition_,
  },
  required: ['required'],
};

Properties

Name	Type	Description
type🔹	SchemaDefinitionType	The type of the schema definition.
description?🔹	string	The description of the schema definition.
items?🔹	SchemaDefinition	The items in the schema definition.
properties?🔹	{ [string]: SchemaDefinition }	The properties of the schema definition.
required?🔹	string[]	The required fields in the schema definition.

---

type🔹

Type: SchemaDefinitionType

The type of the schema definition.

This field specifies the data type of the schema.

---

description?🔹

Type: string (optional, default: No description)

The description of the schema definition.

This description provides information about the purpose and usage of the schema.

---

items?🔹

Type: SchemaDefinition (optional, default: No items definition)

The items in the schema definition.

This field is used for array types to define the structure of the array elements.

---

properties?🔹

Type: { [string]: SchemaDefinition } (optional, default: No properties)

The properties of the schema definition.

These properties define the fields in the schema.

---

required?🔹

Type: string[] (optional, default: No required fields)

The required fields in the schema definition.

These fields must be provided when using the schema.