SecurityAgent / Client / list_pentest_job_tasks

list_pentest_job_tasks¶

SecurityAgent.Client.list_pentest_job_tasks(**kwargs)¶

Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.

Request Syntax

response = client.list_pentest_job_tasks(
    agentSpaceId='string',
    maxResults=123,
    pentestJobId='string',
    stepName='PREFLIGHT'|'STATIC_ANALYSIS'|'PENTEST'|'FINALIZING',
    categoryName='string',
    nextToken='string'
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space.
maxResults (integer) – The maximum number of results to return in a single call.
pentestJobId (string) – The unique identifier of the pentest job to list tasks for.
stepName (string) – Filter tasks by step name. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, and FINALIZING.
categoryName (string) – Filter tasks by category name.
nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

Return type:

dict

Returns:

Response Syntax

{
    'taskSummaries': [
        {
            'taskId': 'string',
            'pentestId': 'string',
            'pentestJobId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            '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',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Output for the ListPentestJobTasks operation.
- taskSummaries (list) –
  
  The list of task summaries.
  - (dict) –
    
    Contains summary information about a task.
    - taskId (string) –
      
      The unique identifier of the task.
    - pentestId (string) –
      
      The unique identifier of the pentest associated with the task.
    - pentestJobId (string) –
      
      The unique identifier of the pentest job that contains the task.
    - agentSpaceId (string) –
      
      The unique identifier of the agent space.
    - title (string) –
      
      The title of the task.
    - riskType (string) –
      
      The type of security risk the task is testing for.
    - executionStatus (string) –
      
      The current execution status of the task.
    - 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.
- nextToken (string) –
  
  A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.