Skip to content

delete_agent_alias

Operation

delete_agent_alias

delete_agent_alias(request: DeleteAgentAliasInput | DeleteAgentAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteAgentAliasInputDict]) -> DeleteAgentAliasOutput

Deletes an alias of an agent.

Parameters:

Name Type Description Default
request DeleteAgentAliasInput | DeleteAgentAliasInputDict | 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[DeleteAgentAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteAgentAliasOutput

An instance of DeleteAgentAliasOutput.

delete_agent_alias async

delete_agent_alias(request: DeleteAgentAliasInput | DeleteAgentAliasInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteAgentAliasInputDict]) -> DeleteAgentAliasOutput

Deletes an alias of an agent.

Parameters:

Name Type Description Default
request DeleteAgentAliasInput | DeleteAgentAliasInputDict | 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[DeleteAgentAliasInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteAgentAliasOutput

An instance of DeleteAgentAliasOutput.

Input

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

DeleteAgentAliasInputDict

Bases: TypedDict

Dictionary form of DeleteAgentAliasInput.

Attributes

agent_alias_id instance-attribute
agent_alias_id: Required[str]

The unique identifier of the alias to delete.

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent that the alias belongs to.

DeleteAgentAliasInput dataclass

Bases: _SerdeShape

Dataclass for DeleteAgentAliasInput structure.

Attributes

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

The unique identifier of the alias to delete.

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

The unique identifier of the agent that the alias belongs to.

Output

DeleteAgentAliasOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteAgentAliasOutput structure.

Attributes

agent_alias_id instance-attribute
agent_alias_id: str

The unique identifier of the alias that was deleted.

agent_alias_status instance-attribute
agent_alias_status: str

The status of the alias.

agent_id instance-attribute
agent_id: str

The unique identifier of the agent that the alias belongs to.

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.