SecurityAgent / Client / list_findings

list_findings

SecurityAgent.Client.list_findings(**kwargs)

Lists findings with filtering and pagination support. When filters are applied, the actual number of results returned may be less than the specified limit

See also: AWS API Documentation

Request Syntax

response = client.list_findings(
    maxResults=123,
    pentestJobId='string',
    agentSpaceId='string',
    nextToken='string',
    riskType='string',
    riskLevel='UNKNOWN'|'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
    status='ACTIVE'|'RESOLVED'|'ACCEPTED'|'FALSE_POSITIVE',
    confidence='FALSE_POSITIVE'|'UNCONFIRMED'|'LOW'|'MEDIUM'|'HIGH',
    name='string'
)

Parameters:

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

• pentestJobId (string) –

  [REQUIRED]

  Identifier of the pentest job for which to retrieve associated findings

• agentSpaceId (string) –

  [REQUIRED]

  ID of the agent space where the pentest job exists

• nextToken (string) – Token for pagination

• riskType (string) – Filter findings by risk type

• riskLevel (string) – Filter findings by risk level

• status (string) – Filter findings by status

• confidence (string) – Filter findings by confidence level

• name (string) – Filter findings by name (case-insensitive substring search)

Return type:

dict

Returns:

Response Syntax

{
    'findingsSummaries': [
        {
            'findingId': 'string',
            'agentSpaceId': 'string',
            'pentestId': 'string',
            'pentestJobId': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'RESOLVED'|'ACCEPTED'|'FALSE_POSITIVE',
            'riskType': 'string',
            'riskLevel': 'UNKNOWN'|'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
            'confidence': 'FALSE_POSITIVE'|'UNCONFIRMED'|'LOW'|'MEDIUM'|'HIGH',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  Output for the ListFindings operation

  • findingsSummaries (list) –

    List of finding summaries matching the filter criteria

    • (dict) –

      Summary information for a security finding

      • findingId (string) –

        Unique identifier for the finding

      • agentSpaceId (string) –

        Identifier of the agent space that created this finding

      • pentestId (string) –

        Identifier of the parent pentest

      • pentestJobId (string) –

        Identifier of the pentest job

      • name (string) –

        Name or title of the finding

      • status (string) –

        Current status of the finding

      • riskType (string) –

        Type of security risk identified

      • riskLevel (string) –

        Severity level of the identified risk

      • confidence (string) –

        Confidence level of the finding

      • createdAt (datetime) –

        Timestamp when the finding was created

      • updatedAt (datetime) –

        Timestamp when the finding was last updated

  • nextToken (string) –

    Token for pagination to retrieve the next set of results