Skip to content

update_agent_alias

Operation

update_agent_alias

update_agent_alias(request: UpdateAgentAliasInput | UpdateAgentAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAgentAliasInputDict]) -> UpdateAgentAliasOutput

Updates configurations for an alias of an agent.

Parameters:

Name Type Description Default
request UpdateAgentAliasInput | UpdateAgentAliasInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateAgentAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateAgentAliasOutput

An instance of UpdateAgentAliasOutput.

update_agent_alias async

update_agent_alias(request: UpdateAgentAliasInput | UpdateAgentAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAgentAliasInputDict]) -> UpdateAgentAliasOutput

Updates configurations for an alias of an agent.

Parameters:

Name Type Description Default
request UpdateAgentAliasInput | UpdateAgentAliasInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateAgentAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateAgentAliasOutput

An instance of UpdateAgentAliasOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateAgentAliasInputDict

Bases: TypedDict

Dictionary form of UpdateAgentAliasInput.

Attributes

agent_alias_id instance-attribute
agent_alias_id: Required[str]

The unique identifier of the alias.

agent_alias_name instance-attribute
agent_alias_name: Required[str]

Specifies a new name for the alias.

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent.

alias_invocation_state instance-attribute
alias_invocation_state: str | 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.

description instance-attribute
description: str | None

Specifies a new description for the alias.

routing_configuration instance-attribute

Contains details about the routing configuration of the alias.

UpdateAgentAliasInput dataclass

Bases: _SerdeShape

Dataclass for UpdateAgentAliasInput structure.

Attributes

agent_alias_id class-attribute instance-attribute
agent_alias_id: str | None = ...

The unique identifier of the alias.

agent_alias_name class-attribute instance-attribute
agent_alias_name: str | None = ...

Specifies a new name for the alias.

agent_id class-attribute instance-attribute
agent_id: str | None = ...

The unique identifier of the agent.

alias_invocation_state class-attribute instance-attribute
alias_invocation_state: str | 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.

description class-attribute instance-attribute
description: str | None = ...

Specifies a new description for the alias.

routing_configuration class-attribute instance-attribute
routing_configuration: list[AgentAliasRoutingConfigurationListItem] | None = ...

Contains details about the routing configuration of the alias.

Output

UpdateAgentAliasOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateAgentAliasOutput structure.

Attributes

agent_alias instance-attribute
agent_alias: AgentAlias

Contains details about the alias that was updated.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.