SecurityAgent / Client / list_pentest_jobs_for_pentest

list_pentest_jobs_for_pentest¶

SecurityAgent.Client.list_pentest_jobs_for_pentest(**kwargs)¶

Lists pentest jobs associated with a pentest

Request Syntax

response = client.list_pentest_jobs_for_pentest(
    maxResults=123,
    pentestId='string',
    agentSpaceId='string',
    nextToken='string'
)

Parameters:

maxResults (integer) – Maximum number of pentest jobs to return in a single request
pentestId (string) –
[REQUIRED]

Identifier of the pentest for which to retrieve associated jobs
agentSpaceId (string) –
[REQUIRED]

ID of the agent space where the pentest exists
nextToken (string) – Token for pagination

Return type:

dict

Returns:

Response Syntax

{
    'pentestJobSummaries': [
        {
            'pentestJobId': 'string',
            'pentestId': 'string',
            'title': 'string',
            'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'FAILED'|'COMPLETED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Output for the ListPentestJobsForPentest operation
- pentestJobSummaries (list) –
  
  List of pentest job summaries associated with the pentest
  - (dict) –
    
    Summary information for a pentest job
    - pentestJobId (string) –
      
      Unique identifier of the pentest job
    - pentestId (string) –
      
      Identifier of the parent pentest
    - title (string) –
      
      Title or name of the pentest
    - status (string) –
      
      Current status of the pentest job
    - createdAt (datetime) –
      
      Timestamp when the pentest job was created
    - updatedAt (datetime) –
      
      Timestamp when the pentest job was last updated
- nextToken (string) –
  
  Token for pagination to retrieve the next set of results