SecurityAgent / Client / list_findings

list_findings¶

SecurityAgent.Client.list_findings(**kwargs)¶

Lists the security findings for a pentest job.

Request Syntax

response = client.list_findings(
    maxResults=123,
    pentestJobId='string',
    codeReviewJobId='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) – The maximum number of results to return in a single call.
pentestJobId (string) – The unique identifier of the pentest job to list findings for.
codeReviewJobId (string) – The unique identifier of the code review job to list findings for. Mutually exclusive with pentestJobId.
agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space.
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.
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.

Return type:

dict

Returns:

Response Syntax

{
    'findingsSummaries': [
        {
            'findingId': 'string',
            'agentSpaceId': 'string',
            'pentestId': 'string',
            'pentestJobId': 'string',
            'codeReviewId': 'string',
            'codeReviewJobId': '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) –
  
  The list of finding summaries.
  - (dict) –
    
    Contains summary information about a security finding.
    - findingId (string) –
      
      The unique identifier of the finding.
    - agentSpaceId (string) –
      
      The unique identifier of the agent space associated with the finding.
    - pentestId (string) –
      
      The unique identifier of the pentest associated with the finding.
    - pentestJobId (string) –
      
      The unique identifier of the pentest job that produced the finding.
    - codeReviewId (string) –
      
      The unique identifier of the code review associated with the finding.
    - codeReviewJobId (string) –
      
      The unique identifier of the code review job that produced the finding.
    - name (string) –
      
      The name of the finding.
    - status (string) –
      
      The current status of the finding.
    - riskType (string) –
      
      The type of security risk identified by the finding.
    - riskLevel (string) –
      
      The risk level of the finding.
    - confidence (string) –
      
      The confidence level of the finding.
    - createdAt (datetime) –
      
      The date and time the finding was created, in UTC format.
    - updatedAt (datetime) –
      
      The date and time the finding 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.