Package software.amazon.awscdk.services.bedrock

Interface CfnAgent.FunctionSchemaProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgent.FunctionSchemaProperty.Jsii$Proxy

Enclosing class:

CfnAgent

@Stability(Stable)
public static interface CfnAgent.FunctionSchemaProperty
extends software.amazon.jsii.JsiiSerializable

Defines functions that each define parameters that the agent needs to invoke from the user.

Each function represents an action in an action group.

This data type is used in the following API operations:

• CreateAgentActionGroup request
• CreateAgentActionGroup response
• UpdateAgentActionGroup request
• UpdateAgentActionGroup response
• GetAgentActionGroup response

Example:

 // 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.*;
 FunctionSchemaProperty functionSchemaProperty = FunctionSchemaProperty.builder()
         .functions(List.of(FunctionProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .description("description")
                 .parameters(Map.of(
                         "parametersKey", ParameterDetailProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .description("description")
                                 .required(false)
                                 .build()))
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-functionschema.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAgent.FunctionSchemaProperty.Builder	A builder for CfnAgent.FunctionSchemaProperty
static final class	CfnAgent.FunctionSchemaProperty.Jsii$Proxy	An implementation for CfnAgent.FunctionSchemaProperty

Method Summary

Modifier and Type	Method	Description
static CfnAgent.FunctionSchemaProperty.Builder	builder()
Object	getFunctions()	A list of functions that each define an action in the action group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFunctions

@Stability(Stable)
@NotNull
Object getFunctions()

A list of functions that each define an action in the action group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-functionschema.html#cfn-bedrock-agent-functionschema-functions

builder

@Stability(Stable)
static CfnAgent.FunctionSchemaProperty.Builder builder()

Returns:

a CfnAgent.FunctionSchemaProperty.Builder of CfnAgent.FunctionSchemaProperty