Interface CfnAgent.IAgentActionGroupProperty

Contains details of the inline agent's action group.

Namespace: Amazon.CDK.AWS.Bedrock

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnAgent.IAgentActionGroupProperty

Syntax (vb)

Public Interface CfnAgent.IAgentActionGroupProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock;

             var agentActionGroupProperty = new AgentActionGroupProperty {
                 ActionGroupName = "actionGroupName",

                 // the properties below are optional
                 ActionGroupExecutor = new ActionGroupExecutorProperty {
                     CustomControl = "customControl",
                     Lambda = "lambda"
                 },
                 ActionGroupState = "actionGroupState",
                 ApiSchema = new APISchemaProperty {
                     Payload = "payload",
                     S3 = new S3IdentifierProperty {
                         S3BucketName = "s3BucketName",
                         S3ObjectKey = "s3ObjectKey"
                     }
                 },
                 Description = "description",
                 FunctionSchema = new FunctionSchemaProperty {
                     Functions = new [] { new FunctionProperty {
                         Name = "name",

                         // the properties below are optional
                         Description = "description",
                         Parameters = new Dictionary<string, object> {
                             { "parametersKey", new ParameterDetailProperty {
                                 Type = "type",

                                 // the properties below are optional
                                 Description = "description",
                                 Required = false
                             } }
                         },
                         RequireConfirmation = "requireConfirmation"
                     } }
                 },
                 ParentActionGroupSignature = "parentActionGroupSignature",
                 SkipResourceInUseCheckOnDelete = false
             };

Synopsis

Properties

ActionGroupExecutor	The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
ActionGroupName	The name of the action group.
ActionGroupState	Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
ApiSchema	Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.
Description	A description of the action group.
FunctionSchema	Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
ParentActionGroupSignature	If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group.
SkipResourceInUseCheckOnDelete	Specifies whether to delete the resource even if it's in use.

Properties

ActionGroupExecutor

The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

object? ActionGroupExecutor { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupexecutor

Type union: either IResolvable or CfnAgent.IActionGroupExecutorProperty

ActionGroupName

The name of the action group.

string ActionGroupName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupname

ActionGroupState

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

string? ActionGroupState { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupstate

ApiSchema

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema.

object? ApiSchema { get; }

Property Value

object

Remarks

For more information, see Action group OpenAPI schemas .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-apischema

Type union: either IResolvable or CfnAgent.IAPISchemaProperty

Description

A description of the action group.

string? Description { get; }

Property Value

string

Remarks

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

FunctionSchema

Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

object? FunctionSchema { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnAgent.IFunctionSchemaProperty

ParentActionGroupSignature

If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group.

string? ParentActionGroupSignature { get; }

Property Value

string

Remarks

During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-parentactiongroupsignature

SkipResourceInUseCheckOnDelete

Specifies whether to delete the resource even if it's in use.

object? SkipResourceInUseCheckOnDelete { get; }

Property Value

object

Remarks

By default, this value is false .

Default: - false

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-skipresourceinusecheckondelete

Type union: either bool or IResolvable