update_agent_alias¶
Operation¶
async
¶
update_agent_alias(input: UpdateAgentAliasInput, plugins: list[Plugin] | None = None) -> UpdateAgentAliasOutput
Updates configurations for an alias of an agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateAgentAliasInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateAgentAliasOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateAgentAliasInput structure.
Attributes¶
class-attribute
instance-attribute
¶
agent_alias_id: str | None = None
The unique identifier of the alias.
class-attribute
instance-attribute
¶
agent_alias_name: str | None = None
Specifies a new name for the alias.
class-attribute
instance-attribute
¶
agent_id: str | None = None
The unique identifier of the agent.
class-attribute
instance-attribute
¶
alias_invocation_state: AliasInvocationState | None = None
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.
class-attribute
instance-attribute
¶
description: str | None = None
Specifies a new description for the alias.
class-attribute
instance-attribute
¶
routing_configuration: list[AgentAliasRoutingConfigurationListItem] | None = None
Contains details about the routing configuration of the alias.
Output¶
dataclass
¶
Dataclass for UpdateAgentAliasOutput structure.
Attributes¶
instance-attribute
¶
agent_alias: AgentAlias
Contains details about the alias that was updated.