:doc:`BedrockAgentCore <../../bedrock-agentcore>` / Paginator / ListMemoryExtractionJobs

************************
ListMemoryExtractionJobs
************************



.. py:class:: BedrockAgentCore.Paginator.ListMemoryExtractionJobs

  ::

    
    paginator = client.get_paginator('list_memory_extraction_jobs')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`BedrockAgentCore.Client.list_memory_extraction_jobs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListMemoryExtractionJobs>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          memoryId='string',
          filter={
              'strategyId': 'string',
              'sessionId': 'string',
              'actorId': 'string',
              'status': 'FAILED'
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type memoryId: string
    :param memoryId: **[REQUIRED]** 

      The unique identifier of the memory to list extraction jobs for.

      

    
    :type filter: dict
    :param filter: 

      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.

        

      
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: 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) --* 

          A token to resume pagination.

          
    