Skip to content

UpdateAgentAliasRequest

Source code in docs_src/capo_bedrock_agent/types/update_agent_alias_request.py
class UpdateAgentAliasRequest(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.</p>"""
    agent_alias_name: "capo_bedrock_agent.types.name.Name"
    """<p>Specifies a new name for the alias.</p>"""
    description: NotRequired["capo_bedrock_agent.types.description.Description"]
    """<p>Specifies a new description for the alias.</p>"""
    routing_configuration: NotRequired[
        "capo_bedrock_agent.types.agent_alias_routing_configuration.AgentAliasRoutingConfiguration"
    ]
    """<p>Contains details about the routing configuration of the alias.</p>"""
    alias_invocation_state: NotRequired[
        "capo_bedrock_agent.types.alias_invocation_state.AliasInvocationState"
    ]
    """<p>The invocation state for the agent alias. To pause the agent alias, set the value to <code>REJECT_INVOCATIONS</code>. To start the agent alias running again, set the value to <code>ACCEPT_INVOCATIONS</code>. Use the <code>GetAgentAlias</code>, or <code>ListAgentAliases</code>, operation to get the invocation state of an agent alias.</p>"""

agent_alias_id instance-attribute

agent_alias_id: AgentAliasId

The unique identifier of the alias.

agent_alias_name instance-attribute

agent_alias_name: Name

Specifies a new name for the alias.

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. To pause the agent alias, set the value to REJECT_INVOCATIONS. To start the agent alias running again, set the value to ACCEPT_INVOCATIONS. Use the GetAgentAlias, or ListAgentAliases, operation to get the invocation state of an agent alias.

description instance-attribute

description: NotRequired[Description]

Specifies a new description for the alias.

routing_configuration instance-attribute

routing_configuration: NotRequired[AgentAliasRoutingConfiguration]

Contains details about the routing configuration of the alias.