delete_agent_runtime¶
Operation¶
delete_agent_runtime
¶
delete_agent_runtime(request: DeleteAgentRuntimeInput | DeleteAgentRuntimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteAgentRuntimeInputDict]) -> DeleteAgentRuntimeOutput
Deletes an Amazon Bedrock AgentCore Runtime, or a single version of an AgentCore Runtime when you provide the version qualifier.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteAgentRuntimeInput | DeleteAgentRuntimeInputDict | 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[DeleteAgentRuntimeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteAgentRuntimeOutput
|
An instance of |
delete_agent_runtime
async
¶
delete_agent_runtime(request: DeleteAgentRuntimeInput | DeleteAgentRuntimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteAgentRuntimeInputDict]) -> DeleteAgentRuntimeOutput
Deletes an Amazon Bedrock AgentCore Runtime, or a single version of an AgentCore Runtime when you provide the version qualifier.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteAgentRuntimeInput | DeleteAgentRuntimeInputDict | 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[DeleteAgentRuntimeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteAgentRuntimeOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeleteAgentRuntimeInputDict
¶
Bases: TypedDict
Dictionary form of DeleteAgentRuntimeInput.
Attributes¶
agent_runtime_id
instance-attribute
¶
The unique identifier of the AgentCore Runtime to delete.
agent_runtime_version
instance-attribute
¶
agent_runtime_version: str | None
The version of the AgentCore Runtime to delete. When you provide this value, only that version is deleted. When you omit it, the entire AgentCore Runtime and all of its versions are deleted.
client_token
instance-attribute
¶
client_token: str | None
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
This field is autopopulated if not provided.
DeleteAgentRuntimeInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteAgentRuntimeInput structure.
Attributes¶
agent_runtime_id
class-attribute
instance-attribute
¶
agent_runtime_id: str | None = ...
The unique identifier of the AgentCore Runtime to delete.
agent_runtime_version
class-attribute
instance-attribute
¶
agent_runtime_version: str | None = ...
The version of the AgentCore Runtime to delete. When you provide this value, only that version is deleted. When you omit it, the entire AgentCore Runtime and all of its versions are deleted.
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request but does not return an error.
This field is autopopulated if not provided.
Output¶
DeleteAgentRuntimeOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteAgentRuntimeOutput structure.
Attributes¶
agent_runtime_id
class-attribute
instance-attribute
¶
agent_runtime_id: str | None = ...
The unique identifier of the AgentCore Runtime.
agent_runtime_version
class-attribute
instance-attribute
¶
agent_runtime_version: str | None = ...
The version of the AgentCore Runtime that was deleted. This value is present only when you delete a single version.
response_metadata
class-attribute
instance-attribute
¶
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.