Bedrock Agent  >  Structures  >  AgentVersion

AgentVersion

Structure Class

AgentVersion dataclass

Contains details about a version of an agent.

Attributes

agent_arn instance-attribute

agent_arn: str

The Amazon Resource Name (ARN) of the agent that the version belongs to.

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 that the version belongs to.

agent_name instance-attribute

agent_name: str

The name of the agent that the version belongs to.

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 that the version belongs to.

created_at instance-attribute

created_at: datetime

The time at which the version was created.

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 version.

failure_reasons class-attribute instance-attribute

failure_reasons: list[str] | None = None

A list of reasons that the API operation on the version failed.

foundation_model class-attribute instance-attribute

foundation_model: str | None = None

The foundation model that the version invokes.

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)

The instructions provided to the agent.

memory_configuration class-attribute instance-attribute

memory_configuration: MemoryConfiguration | None = None

Contains details of the memory configuration on the version of the agent.

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

A list of recommended actions to take for the failed API operation on the version to succeed.

updated_at instance-attribute

updated_at: datetime

The time at which the version was last updated.

version instance-attribute

version: str

The version number.