SecurityAgent / Client / list_discovered_endpoints

list_discovered_endpoints

SecurityAgent.Client.list_discovered_endpoints(**kwargs)

Returns a paginated list of endpoints discovered during a pentest job execution.

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) – The maximum number of results to return in a single call.

  • pentestJobId (string) –

    [REQUIRED]

    The unique identifier of the pentest job to list discovered endpoints for.

  • agentSpaceId (string) –

    [REQUIRED]

    The unique identifier of the agent space.

  • prefix (string) – A prefix to filter discovered endpoints by URI.

  • 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.

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

      The list of discovered endpoints.

      • (dict) –

        Represents an endpoint discovered during a pentest job.

        • uri (string) –

          The URI of the discovered endpoint.

        • pentestJobId (string) –

          The unique identifier of the pentest job that discovered the endpoint.

        • taskId (string) –

          The unique identifier of the task that discovered the endpoint.

        • agentSpaceId (string) –

          The unique identifier of the agent space associated with the discovered endpoint.

        • evidence (string) –

          The evidence that led to the discovery of the endpoint.

        • operation (string) –

          The HTTP operation associated with the discovered endpoint.

        • description (string) –

          A description of the discovered endpoint.

    • 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.