SecurityAgent / Client / list_discovered_endpoints

list_discovered_endpoints

SecurityAgent.Client.list_discovered_endpoints(**kwargs)

Lists discovered endpoints associated with a pentest job with optional URI prefix filtering

See also: AWS API Documentation

Request Syntax

response = client.list_discovered_endpoints(
    maxResults=123,
    pentestJobId='string',
    agentSpaceId='string',
    prefix='string',
    nextToken='string'
)
Parameters:

  • maxResults (integer) – Maximum number of discovered endpoints to return in a single request (default: 50)

  • 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

  • nextToken (string) – Token for pagination

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

      Token for pagination to retrieve the next set of results