SecurityAgent / Client / list_pentests

list_pentests¶

SecurityAgent.Client.list_pentests(**kwargs)¶

Returns a paginated list of pentest summaries for the specified agent space.

Request Syntax

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

Parameters:

maxResults (integer) – The maximum number of results to return in a single call.
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.
agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space to list pentests for.

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) –
  
  The list of pentest summaries.
  - (dict) –
    
    Contains summary information about a pentest.
    - pentestId (string) –
      
      The unique identifier of the pentest.
    - agentSpaceId (string) –
      
      The unique identifier of the agent space that contains the pentest.
    - title (string) –
      
      The title of the pentest.
    - createdAt (datetime) –
      
      The date and time the pentest was created, in UTC format.
    - updatedAt (datetime) –
      
      The date and time the pentest 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.