SecurityIncidentResponse / Paginator / ListInvestigations

ListInvestigations¶

class SecurityIncidentResponse.Paginator.ListInvestigations¶

paginator = client.get_paginator('list_investigations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from SecurityIncidentResponse.Client.list_investigations().

Request Syntax

response_iterator = paginator.paginate(
    caseId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

caseId (string) –
[REQUIRED]

Investigation performed by an agent for a security incident per caseID
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

{
    'investigationActions': [
        {
            'investigationId': 'string',
            'actionType': 'Evidence'|'Investigation'|'Summarization',
            'title': 'string',
            'content': 'string',
            'status': 'Pending'|'InProgress'|'Waiting'|'Completed'|'Failed'|'Cancelled',
            'lastUpdated': datetime(2015, 1, 1),
            'feedback': {
                'usefulness': 'USEFUL'|'NOT_USEFUL',
                'comment': 'string',
                'submittedAt': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- investigationActions (list) –
  
  Investigation performed by an agent for a security incid…Unique identifier for the specific investigation>
  - (dict) –
    
    Represents an investigation action performed within a case. This structure captures the details of an automated or manual investigation, including its status, results, and user feedback.
    - investigationId (string) –
      
      The unique identifier for this investigation action. This ID is used to track and reference the specific investigation throughout its lifecycle.
    - actionType (string) –
      
      The type of investigation action being performed. This categorizes the investigation method or approach used in the case.
    - title (string) –
      
      Human-readable summary of the investigation focus. This provides a brief description of what the investigation is examining or analyzing.
    - content (string) –
      
      Detailed investigation results in rich markdown format. This field contains the comprehensive findings, analysis, and conclusions from the investigation.
    - status (string) –
      
      The current execution status of the investigation. This indicates whether the investigation is pending, in progress, completed, or failed.
    - lastUpdated (datetime) –
      
      ISO 8601 timestamp of the most recent status update. This indicates when the investigation was last modified or when its status last changed.
    - feedback (dict) –
      
      User feedback for this investigation result. This contains the user’s assessment and comments about the quality and usefulness of the investigation findings.
      - usefulness (string) –
        
        User assessment of the investigation result’s quality and helpfulness. This rating indicates how valuable the investigation findings were in addressing the case.
      - comment (string) –
        
        Optional user comments providing additional context about the investigation feedback. This allows users to explain their rating or provide suggestions for improvement.
      - submittedAt (datetime) –
        
        ISO 8601 timestamp when the feedback was submitted. This records when the user provided their assessment of the investigation results.
- NextToken (string) –
  
  A token to resume pagination.