Skip to content

Bedrock Agent  >  Structures  >  Agent

Agent

Structure Class

Agent dataclass

Contains details about an agent.

Attributes

agent_arn instance-attribute 
agent_arn: str

The Amazon Resource Name (ARN) of the agent.

agent_collaboration class-attribute instance-attribute 
agent_collaboration: AgentCollaboration | None = None

The agent's collaboration settings.

agent_id instance-attribute 
agent_id: str

The unique identifier of the agent.

agent_name instance-attribute 
agent_name: str

The name of the agent.

agent_resource_role_arn instance-attribute 
agent_resource_role_arn: str

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

agent_status instance-attribute 
agent_status: 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.

agent_version instance-attribute 
agent_version: str

The version of the agent.

client_token class-attribute instance-attribute 
client_token: str | None = None

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.

created_at instance-attribute 
created_at: datetime

The time at which the agent was created.

custom_orchestration class-attribute instance-attribute 
custom_orchestration: CustomOrchestration | None = None

Contains custom orchestration configurations for the agent.

customer_encryption_key_arn class-attribute instance-attribute 
customer_encryption_key_arn: str | None = None

The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.

description class-attribute instance-attribute 
description: str | None = None

The description of the agent.

failure_reasons class-attribute instance-attribute 
failure_reasons: list[str] | None = None

Contains reasons that the agent-related API that you invoked failed.

foundation_model class-attribute instance-attribute 
foundation_model: str | None = None

The foundation model used for orchestration by the agent.

guardrail_configuration class-attribute instance-attribute 
guardrail_configuration: GuardrailConfiguration | None = None

Details about the guardrail associated with the agent.

idle_session_ttl_in_seconds instance-attribute 
idle_session_ttl_in_seconds: int

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.

instruction class-attribute instance-attribute 
instruction: str | None = field(repr=False, default=None)

Instructions that tell the agent what it should do and how it should interact with users.

memory_configuration class-attribute instance-attribute 
memory_configuration: MemoryConfiguration | None = None

Contains memory configuration for the agent.

orchestration_type class-attribute instance-attribute 
orchestration_type: OrchestrationType | None = None

Specifies the orchestration strategy for the agent.

prepared_at class-attribute instance-attribute 
prepared_at: datetime | None = None

The time at which the agent was last prepared.

prompt_override_configuration class-attribute instance-attribute 
prompt_override_configuration: PromptOverrideConfiguration | None = field(repr=False, default=None)

Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

recommended_actions class-attribute instance-attribute 
recommended_actions: list[str] | None = None

Contains recommended actions to take for the agent-related API that you invoked to succeed.

updated_at instance-attribute 
updated_at: datetime

The time at which the agent was last updated.