BedrockAgentCore / Client / list_memory_extraction_jobs

list_memory_extraction_jobs¶

BedrockAgentCore.Client.list_memory_extraction_jobs(**kwargs)¶

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.

Request Syntax

response = client.list_memory_extraction_jobs(
    memoryId='string',
    maxResults=123,
    filter={
        'strategyId': 'string',
        'sessionId': 'string',
        'actorId': 'string',
        'status': 'FAILED'
    },
    nextToken='string'
)

Parameters:

memoryId (string) –
[REQUIRED]

The unique identifier of the memory to list extraction jobs for.
maxResults (integer) – The maximum number of results to return in a single call. The default value is 20.
filter (dict) –
Filter criteria to apply when listing extraction jobs.
- strategyId (string) –
  
  The memory strategy identifier to filter extraction jobs by. If specified, only extraction jobs with this strategy ID are returned.
- sessionId (string) –
  
  The unique identifier of the session. If specified, only extraction jobs with this session ID are returned.
- actorId (string) –
  
  The identifier of the actor. If specified, only extraction jobs with this actor ID are returned.
- status (string) –
  
  The status of the extraction job. If specified, only extraction jobs with this status are returned.
nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'jobs': [
        {
            'jobID': 'string',
            'messages': {
                'messagesList': [
                    {
                        'eventId': 'string',
                        'messageIndex': 123
                    },
                ]
            },
            'status': 'FAILED',
            'failureReason': 'string',
            'strategyId': 'string',
            'sessionId': 'string',
            'actorId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- jobs (list) –
  
  List of extraction job metadata matching the specified criteria.
  - (dict) –
    
    Metadata information associated with this extraction job.
    - jobID (string) –
      
      The unique identifier for the extraction job.
    - messages (dict) –
      
      The messages associated with the extraction job.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: messagesList. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - messagesList (list) –
        
        The list of messages that compose this extraction job.
        
        (dict) –
        
        Metadata information associated with this message.
        
        eventId (string) –
        
        The identifier of the event associated with this message.
        
        messageIndex (integer) –
        
        The position of this message within that event’s ordered list of messages.
    - status (string) –
      
      The current status of the extraction job.
    - failureReason (string) –
      
      The cause of failure, if the job did not complete successfully.
    - strategyId (string) –
      
      The identifier of the memory strategy for this extraction job.
    - sessionId (string) –
      
      The identifier of the session for this extraction job.
    - actorId (string) –
      
      The identifier of the actor for this extraction job.
- nextToken (string) –
  
  Token to retrieve the next page of results, if available.

Exceptions

BedrockAgentCore.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCore.Client.exceptions.ThrottledException
BedrockAgentCore.Client.exceptions.ServiceException
BedrockAgentCore.Client.exceptions.AccessDeniedException
BedrockAgentCore.Client.exceptions.ValidationException
BedrockAgentCore.Client.exceptions.ResourceNotFoundException