Bedrock Agent

This table represents the Bedrock Agent resource from Amazon Web Services.

aws.bedrock_agent

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
agent_arncorestringThe Amazon Resource Name (ARN) of the agent.
agent_collaborationcorestringThe agent's collaboration settings.
agent_collaborator_summariescorejsonA list of collaborator summaries.
agent_idcorestringThe unique identifier of the agent.
agent_namecorestringThe name of the agent.
agent_resource_role_arncorestringThe Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
agent_statuscorestringThe status of the agent and whether it is ready for use. The following statuses are possible: <ul> <li> CREATING – The agent is being created. </li> <li> PREPARING – The agent is being prepared. </li> <li> PREPARED – The agent is prepared and ready to be invoked. </li> <li> NOT_PREPARED – The agent has been created but not yet prepared. </li> <li> FAILED – The agent API operation failed. </li> <li> UPDATING – The agent is being updated. </li> <li> DELETING – The agent is being deleted. </li> </ul>
agent_versioncorestringThe version of the agent.
agent_version_summariescorejsonA list of objects, each of which contains information about a version of the agent.
client_tokencorestringA 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.
created_atcoretimestampThe time at which the agent was created.
custom_orchestrationcorejsonContains custom orchestration configurations for the agent.
customer_encryption_key_arncorestringThe Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
descriptioncorestringThe description of the agent.
failure_reasonscorearray<string>Contains reasons that the agent-related API that you invoked failed.
foundation_modelcorestringThe foundation model used for orchestration by the agent.
guardrail_configurationcorejsonDetails about the guardrail associated with the agent.
idle_session_ttl_in_secondscoreint64The 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.
instructioncorestringInstructions that tell the agent what it should do and how it should interact with users.
memory_configurationcorejsonContains memory configuration for the agent.
orchestration_typecorestringSpecifies the orchestration strategy for the agent.
prepared_atcoretimestampThe time at which the agent was last prepared.
prompt_override_configurationcorejsonContains configurations to override prompt templates in different parts of an agent sequence. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.
recommended_actionscorearray<string>Contains recommended actions to take for the agent-related API that you invoked to succeed.
tagscorehstore
updated_atcoretimestampThe time at which the agent was last updated.