InlineToolSchema

class aws_cdk.aws_bedrockagentcore.InlineToolSchema(schema)

Bases: ToolSchema

Class to define a Tool Schema from an inline string.

The schema can be provided directly as a string in either JSON or YAML format.

ExampleMetadata:: infused

Example:

tool_schema = agentcore.ToolSchema.from_inline([
    name="hello_world",
    description="A simple hello world tool",
    input_schema=agentcore.SchemaDefinition(
        type=agentcore.SchemaDefinitionType.OBJECT,
        properties={
            "name": agentcore.SchemaDefinition(
                type=agentcore.SchemaDefinitionType.STRING,
                description="The name to greet"
            )
        },
        required=["name"]
    )
])

Parameters:: schema (Sequence[Union[ToolDefinition, Dict[str, Any]]])

Methods

bind(scope)

Bind the schema to a construct.

Parameters:: scope (Construct)
Return type:: None

grant_permissions_to_role(_role)

Grant permissions to the role.

Parameters:: _role (IRole)
Return type:: None

Attributes

bucket_owner_account_id: The account ID of the S3 bucket owner for cross-account access.

inline_schema

The inline tool schema definition as a string, if using an inline schema.

Can be in JSON or YAML format.

s3_file

The S3 location of the tool schema file, if using an S3-based schema.

Contains the bucket name and object key information.

Static Methods

classmethod from_inline(schema)

Creates a Tool Schema from an inline string.

Parameters:

schema (Sequence[Union[ToolDefinition, Dict[str, Any]]]) –

the JSON or YAML payload defining the OpenAPI schema for the action group.

Return type:

InlineToolSchema

classmethod from_local_asset(path)

Creates a tool Schema from a local file.

Parameters:

path (str) –

the path to the local file containing the function schema for the tool.

Return type:

ToolSchema

classmethod from_s3_file(bucket, object_key, bucket_owner_account_id=None)

Creates a Tool Schema from an S3 File.

Parameters:

bucket (IBucket) –
- the bucket containing the local file containing the OpenAPI schema for the action group.
object_key (str) –
- object key in the bucket.
bucket_owner_account_id (Optional[str]) –
- optional The account ID of the Amazon S3 bucket owner. This ID is used for cross-account access to the bucket.

Return type:

S3ToolSchema