SchemaDefinition

class aws_cdk.aws_bedrock_agentcore_alpha.SchemaDefinition(*, type, description=None, items=None, properties=None, required=None)

Bases: object

(experimental) Schema definition for tool input/output.

Parameters:

  • type (SchemaDefinitionType) – (experimental) The type of the schema definition. This field specifies the data type of the schema.

  • description (Optional[str]) – (experimental) The description of the schema definition. This description provides information about the purpose and usage of the schema. Default: - No description

  • items (Union[SchemaDefinition, Dict[str, Any], None]) – (experimental) The items in the schema definition. This field is used for array types to define the structure of the array elements. Default: - No items definition

  • properties (Optional[Mapping[str, Union[SchemaDefinition, Dict[str, Any]]]]) – (experimental) The properties of the schema definition. These properties define the fields in the schema. Default: - No properties

  • required (Optional[Sequence[str]]) – (experimental) The required fields in the schema definition. These fields must be provided when using the schema. Default: - No required fields

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha

# schema_definition_: bedrock_agentcore_alpha.SchemaDefinition

schema_definition = bedrock_agentcore_alpha.SchemaDefinition(
    type=bedrock_agentcore_alpha.SchemaDefinitionType.STRING,

    # the properties below are optional
    description="description",
    items=schema_definition_,
    properties={
        "properties_key": schema_definition_
    },
    required=["required"]
)

Attributes

description

(experimental) The description of the schema definition.

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

Default:

  • No description

Stability:

experimental

items

(experimental) The items in the schema definition.

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

Default:

  • No items definition

Stability:

experimental

properties

(experimental) The properties of the schema definition.

These properties define the fields in the schema.

Default:

  • No properties

Stability:

experimental

required

(experimental) The required fields in the schema definition.

These fields must be provided when using the schema.

Default:

  • No required fields

Stability:

experimental

type

(experimental) The type of the schema definition.

This field specifies the data type of the schema.

Stability:

experimental