SecurityAgent / Client / batch_get_code_review_job_tasks

batch_get_code_review_job_tasks¶

SecurityAgent.Client.batch_get_code_review_job_tasks(**kwargs)¶

Retrieves information about one or more tasks within a code review job.

Request Syntax

response = client.batch_get_code_review_job_tasks(
    agentSpaceId='string',
    codeReviewJobTaskIds=[
        'string',
    ]
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space that contains the tasks.
codeReviewJobTaskIds (list) –
[REQUIRED]

The list of task identifiers to retrieve.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'codeReviewJobTasks': [
        {
            'taskId': 'string',
            'codeReviewId': 'string',
            'codeReviewJobId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'description': 'string',
            'categories': [
                {
                    'name': 'string',
                    'isPrimary': True|False
                },
            ],
            'riskType': 'CROSS_SITE_SCRIPTING'|'DEFAULT_CREDENTIALS'|'INSECURE_DIRECT_OBJECT_REFERENCE'|'PRIVILEGE_ESCALATION'|'SERVER_SIDE_TEMPLATE_INJECTION'|'COMMAND_INJECTION'|'CODE_INJECTION'|'SQL_INJECTION'|'ARBITRARY_FILE_UPLOAD'|'INSECURE_DESERIALIZATION'|'LOCAL_FILE_INCLUSION'|'INFORMATION_DISCLOSURE'|'PATH_TRAVERSAL'|'SERVER_SIDE_REQUEST_FORGERY'|'JSON_WEB_TOKEN_VULNERABILITIES'|'XML_EXTERNAL_ENTITY'|'FILE_DELETION'|'OTHER'|'GRAPHQL_VULNERABILITIES'|'BUSINESS_LOGIC_VULNERABILITIES'|'CRYPTOGRAPHIC_VULNERABILITIES'|'DENIAL_OF_SERVICE'|'FILE_ACCESS'|'FILE_CREATION'|'DATABASE_MODIFICATION'|'DATABASE_ACCESS'|'OUTBOUND_SERVICE_REQUEST'|'UNKNOWN',
            'executionStatus': 'IN_PROGRESS'|'ABORTED'|'COMPLETED'|'INTERNAL_ERROR'|'FAILED',
            'logsLocation': {
                'logType': 'CLOUDWATCH',
                'cloudWatchLog': {
                    'logGroup': 'string',
                    'logStream': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

(dict) –

Output for the BatchGetCodeReviewJobTasks operation.
- codeReviewJobTasks (list) –
  
  The list of code review job tasks that were found.
  - (dict) –
    
    Represents an individual security test task within a code review job. Each task targets a specific risk type and executes independently.
    - taskId (string) –
      
      The unique identifier of the task.
    - codeReviewId (string) –
      
      The unique identifier of the code review associated with the task.
    - codeReviewJobId (string) –
      
      The unique identifier of the code review job that contains the task.
    - agentSpaceId (string) –
      
      The unique identifier of the agent space.
    - title (string) –
      
      The title of the task.
    - description (string) –
      
      A description of the task.
    - categories (list) –
      
      The list of categories assigned to the task.
      - (dict) –
        
        Represents a category assigned to a security testing task.
        
        name (string) –
        
        The name of the category.
        
        isPrimary (boolean) –
        
        Indicates whether this is the primary category for the task.
    - riskType (string) –
      
      The type of security risk the task is testing for.
    - executionStatus (string) –
      
      The current execution status of the task.
    - logsLocation (dict) –
      
      The location of the task execution logs.
      - logType (string) –
        
        The type of log storage. Currently, only CLOUDWATCH is supported.
      - cloudWatchLog (dict) –
        
        The CloudWatch Logs location for the task logs.
        
        logGroup (string) –
        
        The name of the CloudWatch log group.
        
        logStream (string) –
        
        The name of the CloudWatch log stream.
    - createdAt (datetime) –
      
      The date and time the task was created, in UTC format.
    - updatedAt (datetime) –
      
      The date and time the task was last updated, in UTC format.
- notFound (list) –
  
  The list of task identifiers that were not found.
  - (string) –