Skip to content

SchemaDefinition

Source code in docs_src/capo_bedrock_agentcore_control/types/schema_definition.py
class SchemaDefinition(TypedDict, closed=True):
    type: "capo_bedrock_agentcore_control.types.schema_type.SchemaType"
    """<p>The type of the schema definition. This field specifies the data type of the schema.</p>"""
    properties: NotRequired[
        "capo_bedrock_agentcore_control.types.schema_properties.SchemaProperties"
    ]
    """<p>The properties of the schema definition. These properties define the fields in the schema.</p>"""
    required: NotRequired[
        "capo_bedrock_agentcore_control.types.required_properties.RequiredProperties"
    ]
    """<p>The required fields in the schema definition. These fields must be provided when using the schema.</p>"""
    items: NotRequired[
        "capo_bedrock_agentcore_control.types.schema_definition.SchemaDefinition"
    ]
    """<p>The items in the schema definition. This field is used for array types to define the structure of the array elements.</p>"""
    description: NotRequired["str"]
    """<p>The description of the schema definition. This description provides information about the purpose and usage of the schema.</p>"""

description instance-attribute

description: NotRequired[str]

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

items instance-attribute

items: NotRequired[SchemaDefinition]

The items in the schema definition. This field is used for array types to define the structure of the array elements.

properties instance-attribute

properties: NotRequired[SchemaProperties]

The properties of the schema definition. These properties define the fields in the schema.

required instance-attribute

required: NotRequired[RequiredProperties]

The required fields in the schema definition. These fields must be provided when using the schema.

type instance-attribute

type: SchemaType

The type of the schema definition. This field specifies the data type of the schema.