DevOpsAgentService / Paginator / ListJournalRecords

ListJournalRecords¶

class DevOpsAgentService.Paginator.ListJournalRecords¶

paginator = client.get_paginator('list_journal_records')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from DevOpsAgentService.Client.list_journal_records().

Request Syntax

response_iterator = paginator.paginate(
    agentSpaceId='string',
    executionId='string',
    recordType='string',
    order='ASC'|'DESC',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier for the agent space containing the execution
executionId (string) –
[REQUIRED]

The unique identifier of the execution whose journal records to retrieve
recordType (string) – Filter records by type (empty string returns all types)
order (string) – Sort order for the records based on timestamp (default: DESC)
PaginationConfig (dict) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'records': [
        {
            'agentSpaceId': 'string',
            'executionId': 'string',
            'recordId': 'string',
            'content': {...}|[...]|123|123.4|'string'|True|None,
            'createdAt': datetime(2015, 1, 1),
            'recordType': 'string',
            'userReference': {
                'userId': 'string',
                'userType': 'IAM'|'IDC'|'IDP'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

Response structure containing a list of journal records
- records (list) –
  
  List of journal records matching the request criteria
  - (dict) –
    
    Represents a journal record containing execution details and content
    - agentSpaceId (string) –
      
      The unique identifier for the agent space containing this record
    - executionId (string) –
      
      The execution ID associated with this journal record
    - recordId (string) –
      
      The unique identifier for this journal record
    - content (document) –
      
      The content of this journal record
    - createdAt (datetime) –
      
      Timestamp when this journal record was created
    - recordType (string) –
      
      The type of this journal record
    - userReference (dict) –
      
      Reference to the user associated with this journal record
      - userId (string) –
        
        The unique identifier for the user
      - userType (string) –
        
        The type of user
- NextToken (string) –
  
  A token to resume pagination.