list_memory_extraction_jobs¶
Operation¶
list_memory_extraction_jobs
¶
list_memory_extraction_jobs(request: ListMemoryExtractionJobsInput | ListMemoryExtractionJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListMemoryExtractionJobsInputDict]) -> ListMemoryExtractionJobsOutput
Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
To use this operation, you must have the
bedrock-agentcore:ListMemoryExtractionJobs permission.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListMemoryExtractionJobsInput | ListMemoryExtractionJobsInputDict | 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[ListMemoryExtractionJobsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListMemoryExtractionJobsOutput
|
An instance of |
list_memory_extraction_jobs
async
¶
list_memory_extraction_jobs(request: ListMemoryExtractionJobsInput | ListMemoryExtractionJobsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListMemoryExtractionJobsInputDict]) -> ListMemoryExtractionJobsOutput
Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
To use this operation, you must have the
bedrock-agentcore:ListMemoryExtractionJobs permission.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListMemoryExtractionJobsInput | ListMemoryExtractionJobsInputDict | 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[ListMemoryExtractionJobsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListMemoryExtractionJobsOutput
|
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.
ListMemoryExtractionJobsInputDict
¶
Bases: TypedDict
Dictionary form of ListMemoryExtractionJobsInput.
Attributes¶
filter
instance-attribute
¶
filter: ExtractionJobFilterInput | ExtractionJobFilterInputDict | None
Filter criteria to apply when listing extraction jobs.
max_results
instance-attribute
¶
max_results: int | None
The maximum number of results to return in a single call. The default value is 20.
memory_id
instance-attribute
¶
The unique identifier of the memory to list extraction jobs for.
ListMemoryExtractionJobsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListMemoryExtractionJobsInput structure.
Attributes¶
filter
class-attribute
instance-attribute
¶
filter: ExtractionJobFilterInput | None = ...
Filter criteria to apply when listing extraction jobs.
max_results
class-attribute
instance-attribute
¶
max_results: int = ...
The maximum number of results to return in a single call. The default value is 20.
Output¶
ListMemoryExtractionJobsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListMemoryExtractionJobsOutput structure.
Attributes¶
jobs
instance-attribute
¶
jobs: list[ExtractionJobMetadata]
List of extraction job metadata matching the specified criteria.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
Token to retrieve the next page of results, if available.
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.