AgentAgentState class
Input properties used for looking up and filtering AgentAgent resources.
Constructors
-
AgentAgentState({Input<
String?> ? agentArn, Input<String?> ? agentCollaboration, Input<String?> ? agentId, Input<String?> ? agentName, Input<String?> ? agentResourceRoleArn, Input<String?> ? agentVersion, Input<String?> ? customerEncryptionKeyArn, Input<String?> ? description, Input<String?> ? foundationModel, Input<List< ? guardrailConfigurations, Input<AgentAgentGuardrailConfiguration> ?>int?> ? idleSessionTtlInSeconds, Input<String?> ? instruction, Input<List< ? memoryConfigurations, Input<AgentAgentMemoryConfiguration> ?>bool?> ? prepareAgent, Input<String?> ? preparedAt, Input<List< ? promptOverrideConfigurations, Input<AgentAgentPromptOverrideConfiguration> ?>String?> ? region, Input<bool?> ? skipResourceInUseCheck, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>AgentAgentTimeouts?> ? timeouts}) -
Creates a new AgentAgentState.
agentArnARN of the agent.agentCollaborationAgents collaboration role. Valid values:SUPERVISOR,SUPERVISOR_ROUTER,DISABLED.agentIdUnique identifier of the agent.agentNameName of the agent.agentResourceRoleArnARN of the IAM role with permissions to invoke API operations on the agent.agentVersionVersion of the agent.customerEncryptionKeyArnARN of the AWS KMS key that encrypts the agent.descriptionDescription of the agent.foundationModelFoundation model used for orchestration by the agent.guardrailConfigurationsDetails about the guardrail associated with the agent. SeeguardrailConfigurationBlock for details.idleSessionTtlInSecondsNumber of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.instructionInstructions that tell the agent what it should do and how it should interact with users. IfprepareAgentistruethis argument is required. The valid range is 40 - 20000 characters.memoryConfigurationsConfigurations for the agent's ability to retain the conversational context.prepareAgentWhether to prepare the agent after creation or modification. Defaults totrue.preparedAtTimestamp of when the agent was last prepared.promptOverrideConfigurationsConfigurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts. SeepromptOverrideConfigurationBlock for details.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 agent.tagsMap of tags assigned to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.timeoutsOptional.const -
AgentAgentState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
agentArn
→ Input<
String?> ? -
ARN of the agent.
final
-
agentCollaboration
→ Input<
String?> ? -
Agents collaboration role. Valid values:
SUPERVISOR,SUPERVISOR_ROUTER,DISABLED.final -
agentId
→ Input<
String?> ? -
Unique identifier of the agent.
final
-
agentName
→ Input<
String?> ? -
Name of the agent.
final
-
agentResourceRoleArn
→ Input<
String?> ? -
ARN of the IAM role with permissions to invoke API operations on the agent.
final
-
agentVersion
→ Input<
String?> ? -
Version of the agent.
final
-
customerEncryptionKeyArn
→ Input<
String?> ? -
ARN of the AWS KMS key that encrypts the agent.
final
-
description
→ Input<
String?> ? -
Description of the agent.
final
-
foundationModel
→ Input<
String?> ? -
Foundation model used for orchestration by the agent.
final
-
guardrailConfigurations
→ Input<
List< ?AgentAgentGuardrailConfiguration> ?> -
Details about the guardrail associated with the agent. See
guardrailConfigurationBlock for details.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
idleSessionTtlInSeconds
→ Input<
int?> ? -
Number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
final
-
instruction
→ Input<
String?> ? -
Instructions that tell the agent what it should do and how it should interact with users. If
prepareAgentistruethis argument is required. The valid range is 40 - 20000 characters.final -
memoryConfigurations
→ Input<
List< ?AgentAgentMemoryConfiguration> ?> -
Configurations for the agent's ability to retain the conversational context.
final
-
prepareAgent
→ Input<
bool?> ? -
Whether to prepare the agent after creation or modification. Defaults to
true.final -
preparedAt
→ Input<
String?> ? -
Timestamp of when the agent was last prepared.
final
-
promptOverrideConfigurations
→ Input<
List< ?AgentAgentPromptOverrideConfiguration> ?> -
Configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts. See
promptOverrideConfigurationBlock for details.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 agent.
final
-
Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
timeouts
→ Input<
AgentAgentTimeouts?> ? -
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