interface ParameterDetailProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnAgentPropsMixin.ParameterDetailProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnAgentPropsMixin_ParameterDetailProperty`
Java	`software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnAgentPropsMixin.ParameterDetailProperty`
Python	`aws_cdk.mixins_preview.aws_bedrock.mixins.CfnAgentPropsMixin.ParameterDetailProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_bedrock` » `mixins` » `CfnAgentPropsMixin` » `ParameterDetailProperty`

Contains details about a parameter in a function for an action group.

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 parameterDetailProperty: bedrock_mixins.CfnAgentPropsMixin.ParameterDetailProperty = {
  description: 'description',
  required: false,
  type: 'type',
};

Properties

Name	Type	Description
description?	`string`	A description of the parameter.
required?	`boolean \|` `IResolvable`	Whether the parameter is required for the agent to complete the function for action group invocation.
type?	`string`	The data type of the parameter.

description?

Type: string (optional)

A description of the parameter.

Helps the foundation model determine how to elicit the parameters from the user.

required?

Type: boolean | IResolvable (optional)

Whether the parameter is required for the agent to complete the function for action group invocation.

type?