Agent
Contains details about an agent.
Contents
- agentArn
-
The Amazon Resource Name (ARN) of the agent.
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.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- agentName
-
The name of the agent.
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 and whether it is ready for use. The following statuses are possible:
-
CREATING – The agent is being created.
-
PREPARING – The agent is being prepared.
-
PREPARED – The agent is prepared and ready to be invoked.
-
NOT_PREPARED – The agent has been created but not yet prepared.
-
FAILED – The agent API operation failed.
-
UPDATING – The agent is being updated.
-
DELETING – The agent is being deleted.
Type: String
Valid Values:
CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATINGRequired: Yes
-
- agentVersion
-
The version of the agent.
Type: String
Length Constraints: Fixed length of 5.
Pattern:
^DRAFT$Required: Yes
- createdAt
-
The time at which the agent 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 agent was last updated.
Type: Timestamp
Required: Yes
- agentCollaboration
-
The agent's collaboration settings.
Type: String
Valid Values:
SUPERVISOR | SUPERVISOR_ROUTER | DISABLEDRequired: No
- clientToken
-
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}$Required: 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
- customOrchestration
-
Contains custom orchestration configurations for the agent.
Type: CustomOrchestration object
Required: No
- description
-
The description of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
- failureReasons
-
Contains reasons that the agent-related API that you invoked 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 used for orchestration by the agent.
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
-
Instructions that tell the agent what it should do and how it should interact with users.
Type: String
Length Constraints: Minimum length of 40. Maximum length of 4000.
Required: No
- memoryConfiguration
-
Contains memory configuration for the agent.
Type: MemoryConfiguration object
Required: No
- orchestrationType
-
Specifies the orchestration strategy for the agent.
Type: String
Valid Values:
DEFAULT | CUSTOM_ORCHESTRATIONRequired: No
- preparedAt
-
The time at which the agent was last prepared.
Type: Timestamp
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
-
Contains recommended actions to take for the agent-related API that you invoked 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:
