AgentVersion
Contains details about a version of an agent.
Contents
- agentArn
-
The Amazon Resource Name (ARN) of the agent that the version belongs to.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$Required: Yes
- agentId
-
The unique identifier of the agent that the version belongs to.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- agentName
-
The name of the agent that the version belongs to.
Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$Required: Yes
- agentResourceRoleArn
-
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$Required: Yes
- agentStatus
-
The status of the agent that the version belongs to.
Type: String
Valid Values:
CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATINGRequired: Yes
- createdAt
-
The time at which the version was created.
Type: Timestamp
Required: Yes
- idleSessionTTLInSeconds
-
The 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.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 3600.
Required: Yes
- updatedAt
-
The time at which the version was last updated.
Type: Timestamp
Required: Yes
- version
-
The version number.
Type: String
Pattern:
^[0-9]{1,5}$Required: Yes
- agentCollaboration
-
The agent's collaboration settings.
Type: String
Valid Values:
SUPERVISOR | SUPERVISOR_ROUTER | DISABLEDRequired: No
- customerEncryptionKeyArn
-
The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$Required: No
- description
-
The description of the version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
- failureReasons
-
A list of reasons that the API operation on the version failed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- foundationModel
-
The foundation model that the version invokes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$Required: No
- guardrailConfiguration
-
Details about the guardrail associated with the agent.
Type: GuardrailConfiguration object
Required: No
- instruction
-
The instructions provided to the agent.
Type: String
Length Constraints: Minimum length of 40. Maximum length of 4000.
Required: No
- memoryConfiguration
-
Contains details of the memory configuration on the version of the agent.
Type: MemoryConfiguration object
Required: No
- promptOverrideConfiguration
-
Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
Type: PromptOverrideConfiguration object
Required: No
- recommendedActions
-
A list of recommended actions to take for the failed API operation on the version to succeed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
