SecurityAgent / Paginator / ListPentestJobTasks

ListPentestJobTasks

class SecurityAgent.Paginator.ListPentestJobTasks
paginator = client.get_paginator('list_pentest_job_tasks')
paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityAgent.Client.list_pentest_job_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agentSpaceId='string',
    pentestJobId='string',
    stepName='PREFLIGHT'|'STATIC_ANALYSIS'|'PENTEST'|'FINALIZING',
    categoryName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • agentSpaceId (string) –

    [REQUIRED]

    ID of the agent space where the pentest exists

  • pentestJobId (string) – Identifier of the pentest job whose tasks to list

  • stepName (string) – Filter tasks by step name

  • categoryName (string) – Filter tasks by category name.

  • 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

{
    '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) –

      List of task summaries associated with the specified pentest job

      • (dict) –

        Summary information for a task

        • taskId (string) –

          Unique identifier for the task

        • pentestId (string) –

          Identifier of the parent pentest

        • pentestJobId (string) –

          Identifier of the pentest job this task belongs to

        • agentSpaceId (string) –

          Identifier of the agent space this task belongs to

        • title (string) –

          Title or name of the task

        • riskType (string) –

          Type of security risk this task is designed to test

        • executionStatus (string) –

          Current status of the task execution

        • createdAt (datetime) –

          Timestamp when the task was created

        • updatedAt (datetime) –

          Timestamp when the task was last updated

    • NextToken (string) –

      A token to resume pagination.