SecurityAgent / Client / list_pentests

list_pentests¶

SecurityAgent.Client.list_pentests(**kwargs)¶

Lists pentests with optional filtering by status

Request Syntax

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

Parameters:

maxResults (integer) – Maximum number of pentests to return in a single request
nextToken (string) – Token for pagination
agentSpaceId (string) –
[REQUIRED]

ID of the agent space where the pentest exists

Return type:

dict

Returns:

Response Syntax

{
    'pentestSummaries': [
        {
            'pentestId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Output for the ListPentests operation
- pentestSummaries (list) –
  
  List of pentest summaries matching the filter criteria
  - (dict) –
    
    Summary information for a pentest
    - pentestId (string) –
      
      Unique identifier for the pentest
    - agentSpaceId (string) –
      
      ID of the agent space where the pentest exists
    - title (string) –
      
      Title or name of the pentest
    - createdAt (datetime) –
      
      Timestamp when the pentest was created
    - updatedAt (datetime) –
      
      Timestamp when the pentest was last updated
- nextToken (string) –
  
  Token for pagination to retrieve the next set of results