Skip to content

delete_agent

Operation

delete_agent

delete_agent(request: DeleteAgentInput | DeleteAgentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteAgentInputDict]) -> DeleteAgentOutput

Deletes an agent.

Parameters:

Name Type Description Default
request DeleteAgentInput | DeleteAgentInputDict | 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[DeleteAgentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteAgentOutput

An instance of DeleteAgentOutput.

delete_agent async

delete_agent(request: DeleteAgentInput | DeleteAgentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteAgentInputDict]) -> DeleteAgentOutput

Deletes an agent.

Parameters:

Name Type Description Default
request DeleteAgentInput | DeleteAgentInputDict | 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[DeleteAgentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteAgentOutput

An instance of DeleteAgentOutput.

Input

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

DeleteAgentInputDict

Bases: TypedDict

Dictionary form of DeleteAgentInput.

Attributes

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent to delete.

skip_resource_in_use_check instance-attribute
skip_resource_in_use_check: bool | None

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

DeleteAgentInput dataclass

Bases: _SerdeShape

Dataclass for DeleteAgentInput structure.

Attributes

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

The unique identifier of the agent to delete.

skip_resource_in_use_check class-attribute instance-attribute
skip_resource_in_use_check: bool = ...

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Output

DeleteAgentOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteAgentOutput structure.

Attributes

agent_id instance-attribute
agent_id: str

The unique identifier of the agent that was deleted.

agent_status instance-attribute
agent_status: str

The status of the agent.

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.