Skip to content

delete_memory

Operation

delete_memory

delete_memory(request: DeleteMemoryInput | DeleteMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteMemoryInputDict]) -> DeleteMemoryOutput

Deletes an Amazon Bedrock AgentCore Memory resource. When you delete a memory resource, it is permanently removed.

Parameters:

Name Type Description Default
request DeleteMemoryInput | DeleteMemoryInputDict | 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[DeleteMemoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteMemoryOutput

An instance of DeleteMemoryOutput.

delete_memory async

delete_memory(request: DeleteMemoryInput | DeleteMemoryInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteMemoryInputDict]) -> DeleteMemoryOutput

Deletes an Amazon Bedrock AgentCore Memory resource. When you delete a memory resource, it is permanently removed.

Parameters:

Name Type Description Default
request DeleteMemoryInput | DeleteMemoryInputDict | 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[DeleteMemoryInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteMemoryOutput

An instance of DeleteMemoryOutput.

Input

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

DeleteMemoryInputDict

Bases: TypedDict

Dictionary form of DeleteMemoryInput.

Attributes

client_token instance-attribute
client_token: str | None

A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique Amazon Web Services identifier.

This field is autopopulated if not provided.

memory_id instance-attribute
memory_id: Required[str]

The unique identifier of the memory to delete.

DeleteMemoryInput dataclass

Bases: _SerdeShape

Dataclass for DeleteMemoryInput structure.

Attributes

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

A client token is used for keeping track of idempotent requests. It can contain a session id which can be around 250 chars, combined with a unique Amazon Web Services identifier.

This field is autopopulated if not provided.

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

The unique identifier of the memory to delete.

Output

DeleteMemoryOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteMemoryOutput structure.

Attributes

memory_id instance-attribute
memory_id: str

The unique identifier of the deleted AgentCore Memory resource.

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.

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

The current status of the AgentCore Memory resource deletion.