Skip to content

start_memory_extraction_job

Operation

start_memory_extraction_job

start_memory_extraction_job(request: StartMemoryExtractionJobInput | StartMemoryExtractionJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartMemoryExtractionJobInputDict]) -> StartMemoryExtractionJobOutput

Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well.

To use this operation, you must have the bedrock-agentcore:StartMemoryExtractionJob permission.

Parameters:

Name Type Description Default
request StartMemoryExtractionJobInput | StartMemoryExtractionJobInputDict | 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[StartMemoryExtractionJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartMemoryExtractionJobOutput

An instance of StartMemoryExtractionJobOutput.

start_memory_extraction_job async

start_memory_extraction_job(request: StartMemoryExtractionJobInput | StartMemoryExtractionJobInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartMemoryExtractionJobInputDict]) -> StartMemoryExtractionJobOutput

Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well.

To use this operation, you must have the bedrock-agentcore:StartMemoryExtractionJob permission.

Parameters:

Name Type Description Default
request StartMemoryExtractionJobInput | StartMemoryExtractionJobInputDict | 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[StartMemoryExtractionJobInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartMemoryExtractionJobOutput

An instance of StartMemoryExtractionJobOutput.

Input

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

StartMemoryExtractionJobInputDict

Bases: TypedDict

Dictionary form of StartMemoryExtractionJobInput.

Attributes

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure idempotent processing of the request.

This field is autopopulated if not provided.

extraction_job instance-attribute

Extraction job to start in this operation.

memory_id instance-attribute
memory_id: Required[str]

The unique identifier of the memory for which to start extraction jobs.

StartMemoryExtractionJobInput dataclass

Bases: _SerdeShape

Dataclass for StartMemoryExtractionJobInput structure.

Attributes

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

A unique, case-sensitive identifier to ensure idempotent processing of the request.

This field is autopopulated if not provided.

extraction_job class-attribute instance-attribute
extraction_job: ExtractionJob | None = ...

Extraction job to start in this operation.

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

The unique identifier of the memory for which to start extraction jobs.

Output

StartMemoryExtractionJobOutput dataclass

Bases: _SerdeShape

Dataclass for StartMemoryExtractionJobOutput structure.

Attributes

job_id instance-attribute
job_id: str

Extraction Job ID that was attempted to start.

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.