interface FunctionProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnAgentPropsMixin.FunctionProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnAgentPropsMixin_FunctionProperty
Java	software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnAgentPropsMixin.FunctionProperty
Python	aws_cdk.mixins_preview.aws_bedrock.mixins.CfnAgentPropsMixin.FunctionProperty
TypeScript	@aws-cdk/mixins-preview » aws_bedrock » mixins » CfnAgentPropsMixin » 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 { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';
const functionProperty: bedrock_mixins.CfnAgentPropsMixin.FunctionProperty = {
  description: 'description',
  name: 'name',
  parameters: {
    parametersKey: {
      description: 'description',
      required: false,
      type: 'type',
    },
  },
  requireConfirmation: 'requireConfirmation',
};

Properties

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

---

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

---

name?

Type: string (optional)

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

---

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

---

requireConfirmation?

Type: string (optional)

Contains information if user confirmation is required to invoke the function.

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