AgentActionGroupArgs

data class AgentActionGroupArgs(val actionGroupExecutor: Output<Either<AgentActionGroupExecutor0PropertiesArgs, AgentActionGroupExecutor1PropertiesArgs>>? = null, val actionGroupName: Output<String>, val actionGroupState: Output<AgentActionGroupState>? = null, val apiSchema: Output<Either<AgentApiSchema0PropertiesArgs, AgentApiSchema1PropertiesArgs>>? = null, val description: Output<String>? = null, val functionSchema: Output<AgentFunctionSchemaArgs>? = null, val parentActionGroupSignature: Output<AgentActionGroupSignature>? = null, val skipResourceInUseCheckOnDelete: Output<Boolean>? = null) : ConvertibleToJava<AgentActionGroupArgs>

Contains the information of an Agent Action Group

Constructors

Link copied to clipboard
constructor(actionGroupExecutor: Output<Either<AgentActionGroupExecutor0PropertiesArgs, AgentActionGroupExecutor1PropertiesArgs>>? = null, actionGroupName: Output<String>, actionGroupState: Output<AgentActionGroupState>? = null, apiSchema: Output<Either<AgentApiSchema0PropertiesArgs, AgentApiSchema1PropertiesArgs>>? = null, description: Output<String>? = null, functionSchema: Output<AgentFunctionSchemaArgs>? = null, parentActionGroupSignature: Output<AgentActionGroupSignature>? = null, skipResourceInUseCheckOnDelete: Output<Boolean>? = null)

Properties

Link copied to clipboard

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.

Link copied to clipboard
val actionGroupName: Output<String>

Name of the action group

Link copied to clipboard

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

Link copied to clipboard

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. For more information, see Action group OpenAPI schemas .

Link copied to clipboard
val description: Output<String>? = null

Description of action group

Link copied to clipboard

Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

Link copied to clipboard

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

Link copied to clipboard

Specifies whether to allow deleting action group while it is in use.

Functions

Link copied to clipboard
open override fun toJava(): AgentActionGroupArgs