SecurityAgent / Paginator / ListDiscoveredEndpoints

ListDiscoveredEndpoints¶

class SecurityAgent.Paginator.ListDiscoveredEndpoints¶

paginator = client.get_paginator('list_discovered_endpoints')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    pentestJobId='string',
    agentSpaceId='string',
    prefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

pentestJobId (string) –
[REQUIRED]

Identifier of the pentest job for which to retrieve discovered endpoints
agentSpaceId (string) –
[REQUIRED]

ID of the agent space where the pentest job exists
prefix (string) – Optional URI prefix filter to narrow down results
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

{
    'discoveredEndpoints': [
        {
            'uri': 'string',
            'pentestJobId': 'string',
            'taskId': 'string',
            'agentSpaceId': 'string',
            'evidence': 'string',
            'operation': 'string',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

Output for the ListDiscoveredEndpoints operation
- discoveredEndpoints (list) –
  
  List of discovered endpoints for the pentest job
  - (dict) –
    
    Represents a discovered endpoint during pentest execution
    - uri (string) –
      
      The URI of the discovered endpoint
    - pentestJobId (string) –
      
      Identifier of the pentest job that discovered this endpoint
    - taskId (string) –
      
      Identifier of the task that discovered this endpoint
    - agentSpaceId (string) –
      
      Identifier of the agent space where the endpoint was discovered
    - evidence (string) –
      
      Optional evidence or additional information about the endpoint
    - operation (string) –
      
      Operation or action associated with the endpoint
    - description (string) –
      
      Additional description of the endpoint
- NextToken (string) –
  
  A token to resume pagination.