Class CfnAgent.AgentActionGroupProperty

Contains details of the inline agent's action group.

Inheritance
System.Object
CfnAgent.AgentActionGroupProperty
Namespace: Amazon.CDK.AwsBedrock
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AgentActionGroupProperty : Object, CfnAgent.IAgentActionGroupProperty
Syntax (vb)
Public Class AgentActionGroupProperty
    Inherits Object
    Implements 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

Constructors

AgentActionGroupProperty()

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.

Constructors

AgentActionGroupProperty()

public AgentActionGroupProperty()

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.

public object ActionGroupExecutor { get; set; }
Property Value

System.Object

Remarks

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

ActionGroupName

The name of the action group.

public string ActionGroupName { get; set; }
Property Value

System.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.

public string ActionGroupState { get; set; }
Property Value

System.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.

public object ApiSchema { get; set; }
Property Value

System.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

Description

A description of the action group.

public string Description { get; set; }
Property Value

System.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.

public object FunctionSchema { get; set; }
Property Value

System.Object

Remarks

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

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.

public string ParentActionGroupSignature { get; set; }
Property Value

System.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.

public object SkipResourceInUseCheckOnDelete { get; set; }
Property Value

System.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

Implements