Skip to content

AgentVersion

Source code in docs_src/capo_bedrock_agent/types/agent_version.py
class AgentVersion(TypedDict, closed=True):
    agent_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the agent that the version belongs to.</p>"""
    agent_name: "capo_bedrock_agent.types.name.Name"
    """<p>The name of the agent that the version belongs to.</p>"""
    agent_arn: "capo_bedrock_agent.types.agent_arn.AgentArn"
    """<p>The Amazon Resource Name (ARN) of the agent that the version belongs to.</p>"""
    version: "capo_bedrock_agent.types.numerical_version.NumericalVersion"
    """<p>The version number.</p>"""
    instruction: NotRequired["capo_bedrock_agent.types.instruction.Instruction"]
    """<p>The instructions provided to the agent.</p>"""
    agent_status: "capo_bedrock_agent.types.agent_status.AgentStatus"
    """<p>The status of the agent that the version belongs to.</p>"""
    foundation_model: NotRequired[
        "capo_bedrock_agent.types.model_identifier.ModelIdentifier"
    ]
    """<p>The foundation model that the version invokes.</p>"""
    description: NotRequired["capo_bedrock_agent.types.description.Description"]
    """<p>The description of the version.</p>"""
    idle_session_ttl_in_seconds: "capo_bedrock_agent.types.session_ttl.SessionTTL"
    """<p>The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.</p> <p>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.</p>"""
    agent_resource_role_arn: "capo_bedrock_agent.types.agent_role_arn.AgentRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.</p>"""
    customer_encryption_key_arn: NotRequired[
        "capo_bedrock_agent.types.kms_key_arn.KmsKeyArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.</p>"""
    created_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time at which the version was created.</p>"""
    updated_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time at which the version was last updated.</p>"""
    failure_reasons: NotRequired[
        "capo_bedrock_agent.types.failure_reasons.FailureReasons"
    ]
    """<p>A list of reasons that the API operation on the version failed.</p>"""
    recommended_actions: NotRequired[
        "capo_bedrock_agent.types.recommended_actions.RecommendedActions"
    ]
    """<p>A list of recommended actions to take for the failed API operation on the version to succeed.</p>"""
    prompt_override_configuration: NotRequired[
        "capo_bedrock_agent.types.prompt_override_configuration.PromptOverrideConfiguration"
    ]
    """<p>Contains 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>.</p>"""
    guardrail_configuration: NotRequired[
        "capo_bedrock_agent.types.guardrail_configuration.GuardrailConfiguration"
    ]
    """<p>Details about the guardrail associated with the agent.</p>"""
    memory_configuration: NotRequired[
        "capo_bedrock_agent.types.memory_configuration.MemoryConfiguration"
    ]
    """<p> Contains details of the memory configuration on the version of the agent. </p>"""
    agent_collaboration: NotRequired[
        "capo_bedrock_agent.types.agent_collaboration.AgentCollaboration"
    ]
    """<p>The agent's collaboration settings.</p>"""

agent_arn instance-attribute

agent_arn: AgentArn

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

agent_collaboration instance-attribute

agent_collaboration: NotRequired[AgentCollaboration]

The agent's collaboration settings.

agent_id instance-attribute

agent_id: Id

The unique identifier of the agent that the version belongs to.

agent_name instance-attribute

agent_name: Name

The name of the agent that the version belongs to.

agent_resource_role_arn instance-attribute

agent_resource_role_arn: AgentRoleArn

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: DateTimestamp

The time at which the version was created.

customer_encryption_key_arn instance-attribute

customer_encryption_key_arn: NotRequired[KmsKeyArn]

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

description instance-attribute

description: NotRequired[Description]

The description of the version.

failure_reasons instance-attribute

failure_reasons: NotRequired[FailureReasons]

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

foundation_model instance-attribute

foundation_model: NotRequired[ModelIdentifier]

The foundation model that the version invokes.

guardrail_configuration instance-attribute

guardrail_configuration: NotRequired[GuardrailConfiguration]

Details about the guardrail associated with the agent.

idle_session_ttl_in_seconds instance-attribute

idle_session_ttl_in_seconds: SessionTTL

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 instance-attribute

instruction: NotRequired[Instruction]

The instructions provided to the agent.

memory_configuration instance-attribute

memory_configuration: NotRequired[MemoryConfiguration]

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

prompt_override_configuration instance-attribute

prompt_override_configuration: NotRequired[PromptOverrideConfiguration]

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

recommended_actions instance-attribute

recommended_actions: NotRequired[RecommendedActions]

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

updated_at instance-attribute

updated_at: DateTimestamp

The time at which the version was last updated.

version instance-attribute

The version number.