interface FunctionProperty

Language	Type name
.NET	Amazon.CDK.aws_bedrock.CfnAgent.FunctionProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnAgent_FunctionProperty
Java	software.amazon.awscdk.services.bedrock.CfnAgent.FunctionProperty
Python	aws_cdk.aws_bedrock.CfnAgent.FunctionProperty
TypeScript	aws-cdk-lib » aws_bedrock » CfnAgent » FunctionProperty

Defines parameters that the agent needs to invoke from the user to complete the function.

Corresponds to 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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const functionProperty: bedrock.CfnAgent.FunctionProperty = {
  name: 'name',

  // the properties below are optional
  description: 'description',
  parameters: {
    parametersKey: {
      type: 'type',

      // the properties below are optional
      description: 'description',
      required: false,
    },
  },
};

Properties

Name	Type	Description
name	string	A name for the function.
description?	string	A description of the function and its purpose.
parameters?	IResolvable | { [string]: IResolvable | ParameterDetailProperty }	The parameters that the agent elicits from the user to fulfill the function.

---

name

Type: string

A name for the function.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-name

---

description?

Type: string (optional)

A description of the function and its purpose.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-description

---

parameters?

Type: IResolvable | { [string]: IResolvable | ParameterDetailProperty } (optional)

The parameters that the agent elicits from the user to fulfill the function.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-parameters