DevOpsAgentService / Client / list_journal_records

list_journal_records¶

DevOpsAgentService.Client.list_journal_records(**kwargs)¶

List journal records for a specific execution

Request Syntax

response = client.list_journal_records(
    agentSpaceId='string',
    executionId='string',
    limit=123,
    nextToken='string',
    recordType='string',
    order='ASC'|'DESC'
)

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
limit (integer) – Maximum number of records to return in a single response (1-100, default: 100)
nextToken (string) – Token for retrieving the next page of results
recordType (string) – Filter records by type (empty string returns all types)
order (string) – Sort order for the records based on timestamp (default: DESC)

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) –
  
  Token for retrieving the next page of results, if more results are available

Exceptions

DevOpsAgentService.Client.exceptions.ValidationException
DevOpsAgentService.Client.exceptions.ContentSizeExceededException
DevOpsAgentService.Client.exceptions.ServiceQuotaExceededException
DevOpsAgentService.Client.exceptions.ConflictException
DevOpsAgentService.Client.exceptions.InternalServerException
DevOpsAgentService.Client.exceptions.AccessDeniedException
DevOpsAgentService.Client.exceptions.ThrottlingException
DevOpsAgentService.Client.exceptions.ResourceNotFoundException
DevOpsAgentService.Client.exceptions.InvalidParameterException