Skip to content

get_agent_alias

Operation

get_agent_alias

get_agent_alias(request: GetAgentAliasInput | GetAgentAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentAliasInputDict]) -> GetAgentAliasOutput

Gets information about an alias of an agent.

Parameters:

Name Type Description Default
request GetAgentAliasInput | GetAgentAliasInputDict | 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[GetAgentAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentAliasOutput

An instance of GetAgentAliasOutput.

get_agent_alias async

get_agent_alias(request: GetAgentAliasInput | GetAgentAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentAliasInputDict]) -> GetAgentAliasOutput

Gets information about an alias of an agent.

Parameters:

Name Type Description Default
request GetAgentAliasInput | GetAgentAliasInputDict | 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[GetAgentAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentAliasOutput

An instance of GetAgentAliasOutput.

Input

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

GetAgentAliasInputDict

Bases: TypedDict

Dictionary form of GetAgentAliasInput.

Attributes

agent_alias_id instance-attribute
agent_alias_id: Required[str]

The unique identifier of the alias for which to get information.

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent to which the alias to get information belongs.

GetAgentAliasInput dataclass

Bases: _SerdeShape

Dataclass for GetAgentAliasInput structure.

Attributes

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

The unique identifier of the alias for which to get information.

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

The unique identifier of the agent to which the alias to get information belongs.

Output

GetAgentAliasOutput dataclass

Bases: _SerdeShape

Dataclass for GetAgentAliasOutput structure.

Attributes

agent_alias instance-attribute
agent_alias: AgentAlias

Contains information about the alias.

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.