Skip to content

AgentAlias

Source code in docs_src/capo_bedrock_agent/types/agent_alias.py
class AgentAlias(TypedDict, closed=True):
    agent_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the agent.</p>"""
    agent_alias_id: "capo_bedrock_agent.types.agent_alias_id.AgentAliasId"
    """<p>The unique identifier of the alias of the agent.</p>"""
    agent_alias_name: "capo_bedrock_agent.types.name.Name"
    """<p>The name of the alias of the agent.</p>"""
    agent_alias_arn: "capo_bedrock_agent.types.agent_alias_arn.AgentAliasArn"
    """<p>The Amazon Resource Name (ARN) of the alias of the agent.</p>"""
    client_token: NotRequired["capo_bedrock_agent.types.client_token.ClientToken"]
    """<p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>"""
    description: NotRequired["capo_bedrock_agent.types.description.Description"]
    """<p>The description of the alias of the agent.</p>"""
    routing_configuration: "capo_bedrock_agent.types.agent_alias_routing_configuration.AgentAliasRoutingConfiguration"
    """<p>Contains details about the routing configuration of the alias.</p>"""
    created_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time at which the alias of the agent was created.</p>"""
    updated_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time at which the alias was last updated.</p>"""
    agent_alias_history_events: NotRequired[
        "capo_bedrock_agent.types.agent_alias_history_events.AgentAliasHistoryEvents"
    ]
    """<p>Contains details about the history of the alias.</p>"""
    agent_alias_status: "capo_bedrock_agent.types.agent_alias_status.AgentAliasStatus"
    """<p>The status of the alias of the agent and whether it is ready for use. The following statuses are possible:</p> <ul> <li> <p>CREATING – The agent alias is being created.</p> </li> <li> <p>PREPARED – The agent alias is finished being created or updated and is ready to be invoked.</p> </li> <li> <p>FAILED – The agent alias API operation failed.</p> </li> <li> <p>UPDATING – The agent alias is being updated.</p> </li> <li> <p>DELETING – The agent alias is being deleted.</p> </li> <li> <p>DISSOCIATED - The agent alias has no version associated with it.</p> </li> </ul>"""
    failure_reasons: NotRequired[
        "capo_bedrock_agent.types.failure_reasons.FailureReasons"
    ]
    """<p>Information on the failure of Provisioned Throughput assigned to an agent alias.</p>"""
    alias_invocation_state: NotRequired[
        "capo_bedrock_agent.types.alias_invocation_state.AliasInvocationState"
    ]
    """<p>The invocation state for the agent alias. If the agent alias is running, the value is <code>ACCEPT_INVOCATIONS</code>. If the agent alias is paused, the value is <code>REJECT_INVOCATIONS</code>. Use the <code>UpdateAgentAlias</code> operation to change the invocation state.</p>"""

agent_alias_arn instance-attribute

agent_alias_arn: AgentAliasArn

The Amazon Resource Name (ARN) of the alias of the agent.

agent_alias_history_events instance-attribute

agent_alias_history_events: NotRequired[AgentAliasHistoryEvents]

Contains details about the history of the alias.

agent_alias_id instance-attribute

agent_alias_id: AgentAliasId

The unique identifier of the alias of the agent.

agent_alias_name instance-attribute

agent_alias_name: Name

The name of the alias of the agent.

agent_alias_status instance-attribute

agent_alias_status: AgentAliasStatus

The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

  • CREATING – The agent alias is being created.

  • PREPARED – The agent alias is finished being created or updated and is ready to be invoked.

  • FAILED – The agent alias API operation failed.

  • UPDATING – The agent alias is being updated.

  • DELETING – The agent alias is being deleted.

  • DISSOCIATED - The agent alias has no version associated with it.

agent_id instance-attribute

agent_id: Id

The unique identifier of the agent.

alias_invocation_state instance-attribute

alias_invocation_state: NotRequired[AliasInvocationState]

The invocation state for the agent alias. If the agent alias is running, the value is ACCEPT_INVOCATIONS. If the agent alias is paused, the value is REJECT_INVOCATIONS. Use the UpdateAgentAlias operation to change the invocation state.

client_token instance-attribute

client_token: NotRequired[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.

created_at instance-attribute

created_at: DateTimestamp

The time at which the alias of the agent was created.

description instance-attribute

description: NotRequired[Description]

The description of the alias of the agent.

failure_reasons instance-attribute

failure_reasons: NotRequired[FailureReasons]

Information on the failure of Provisioned Throughput assigned to an agent alias.

routing_configuration instance-attribute

routing_configuration: AgentAliasRoutingConfiguration

Contains details about the routing configuration of the alias.

updated_at instance-attribute

updated_at: DateTimestamp

The time at which the alias was last updated.