AgentAgentActionGroupState class
Input properties used for looking up and filtering AgentAgentActionGroup resources.
Constructors
-
AgentAgentActionGroupState({Input<
AgentAgentActionGroupActionGroupExecutor?> ? actionGroupExecutor, Input<String?> ? actionGroupId, Input<String?> ? actionGroupName, Input<String?> ? actionGroupState, Input<String?> ? agentId, Input<String?> ? agentVersion, Input<AgentAgentActionGroupApiSchema?> ? apiSchema, Input<String?> ? description, Input<AgentAgentActionGroupFunctionSchema?> ? functionSchema, Input<String?> ? parentActionGroupSignature, Input<bool?> ? prepareAgent, Input<String?> ? region, Input<bool?> ? skipResourceInUseCheck, Input<AgentAgentActionGroupTimeouts?> ? timeouts}) -
Creates a new AgentAgentActionGroupState.
actionGroupExecutorARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. SeeactionGroupExecutorBlock for details.actionGroupIdUnique identifier of the action group.actionGroupNameName of the action group.actionGroupStateWhether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values:ENABLED,DISABLED.agentIdThe unique identifier of the agent for which to create the action group.agentVersionVersion of the agent for which to create the action group. Valid values:DRAFT.apiSchemaEither 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. SeeapiSchemaBlock for details.descriptionDescription of the action group.functionSchemaDescribes the function schema for the action group.parentActionGroupSignatureTo allow your agent to request the user for additional information when trying to complete a task, set this argument toAMAZON.UserInput. You must leave thedescription,apiSchema, andactionGroupExecutorarguments blank for this action group. Valid values:AMAZON.UserInput.prepareAgentWhether or not to prepare the agent after creation or modification. Defaults totrue.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.skipResourceInUseCheckWhether the in-use check is skipped when deleting the action group.timeoutsOptional.const -
AgentAgentActionGroupState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
actionGroupExecutor
→ Input<
AgentAgentActionGroupActionGroupExecutor?> ? -
ARN of the Lambda function containing the business logic that is carried out upon invoking the action or custom control method for handling the information elicited from the user. See
actionGroupExecutorBlock for details.final -
actionGroupId
→ Input<
String?> ? -
Unique identifier of the action group.
final
-
actionGroupName
→ Input<
String?> ? -
Name of the action group.
final
-
actionGroupState
→ Input<
String?> ? -
Whether the action group is available for the agent to invoke or not when sending an InvokeAgent request. Valid values:
ENABLED,DISABLED.final -
agentId
→ Input<
String?> ? -
The unique identifier of the agent for which to create the action group.
final
-
agentVersion
→ Input<
String?> ? -
Version of the agent for which to create the action group. Valid values:
DRAFT.final -
apiSchema
→ Input<
AgentAgentActionGroupApiSchema?> ? -
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. See
apiSchemaBlock for details.final -
description
→ Input<
String?> ? -
Description of the action group.
final
-
functionSchema
→ Input<
AgentAgentActionGroupFunctionSchema?> ? -
Describes the function schema for the action group.
Each function represents an action in an action group.
See
functionSchemaBlock for details.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
parentActionGroupSignature
→ Input<
String?> ? -
To allow your agent to request the user for additional information when trying to complete a task, set this argument to
AMAZON.UserInput. You must leave thedescription,apiSchema, andactionGroupExecutorarguments blank for this action group. Valid values:AMAZON.UserInput.final -
prepareAgent
→ Input<
bool?> ? -
Whether or not to prepare the agent after creation or modification. Defaults to
true.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
skipResourceInUseCheck
→ Input<
bool?> ? -
Whether the in-use check is skipped when deleting the action group.
final
-
timeouts
→ Input<
AgentAgentActionGroupTimeouts?> ? -
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited