Continuum / Client / list_code_findings

list_code_findings¶

Continuum.Client.list_code_findings(**kwargs)¶

Lists the findings in an environment in descending findingId order.

Request Syntax

response = client.list_code_findings(
    environmentId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

environmentId (string) –
[REQUIRED]

The environment whose findings to list.
maxResults (integer) – The maximum number of results to return in a single call.
nextToken (string) – A pagination token returned by a previous call. Set to null for the first request; use the returned token for subsequent calls.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'findingId': 'string',
            'findingArn': 'string',
            'environmentId': 'string',
            'source': 'string',
            'sourceFindingId': 'string',
            'reportedAt': datetime(2015, 1, 1),
            'status': 'SUBMITTED'|'VALIDATING'|'CONFIRMED'|'DISCARDED',
            'statusUpdatedAt': datetime(2015, 1, 1),
            'createdAt': datetime(2015, 1, 1),
            'scanRunId': 'string',
            'statusMessage': 'string',
            'discardReason': 'SCANNER_VALIDATED_FALSE_POSITIVE'|'SCANNER_NEEDS_REVIEW'|'FALSE_POSITIVE_VALIDATED_AGAINST_CONTEXT'|'DUPLICATE_OF_OPEN_ISSUE'|'DUPLICATE_OF_CLOSED_ISSUE'|'COMPENSATING_CONTROL_PRESENT'|'OUT_OF_SCOPE'|'INSUFFICIENT_EVIDENCE'|'PROCESSING_FAILED'|'SOURCE_REPO_NOT_FOUND',
            'discardReasoning': 'string',
            'duplicateOfIssueId': 'string',
            'createdIssueId': 'string',
            'completedAt': datetime(2015, 1, 1),
            'type': 'CONTINUUM_CODE_VULN'|'CUSTOMER_CODE_VULN',
            'title': 'string',
            'severity': 'UNKNOWN'|'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL'|'FATAL'|'OTHER',
            'category': 'string',
            'filePath': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –

Contains the list of finding summaries and an optional pagination token.
- items (list) –
  
  The findings in the environment, ordered by findingId descending.
  - (dict) –
    
    A summary of a finding returned in list responses. Shares FindingLifecycleFields with the read operations so the list and get projections cannot drift. Carries a lean content subset – fetch the finding for its full contents.
    - findingId (string) –
      
      The unique identifier of the finding.
    - findingArn (string) –
      
      The ARN of the finding.
    - environmentId (string) –
      
      The environment that owns the finding.
    - source (string) –
      
      The system that produced the finding.
    - sourceFindingId (string) –
      
      The producer’s own identifier for the finding.
    - reportedAt (datetime) –
      
      When the producer reported the finding – its own clock, which is not Continuum’s ingestion time. createdAt is when Continuum accepted it; these are genuinely different instants and a reader usually wants this one.
      
      For CreateCodeFinding, this is the submitted OCSF document’s own top-level time. For findings Continuum’s scanner produces, it is the finding’s own creation time.
      
      Continuum does not validate it for plausibility: a producer’s value is echoed as given, so a timestamp here asserts the unit and format, not that the instant is genuine.
    - status (string) –
      
      The current lifecycle status of the finding.
    - statusUpdatedAt (datetime) –
      
      The timestamp when the status last transitioned.
    - createdAt (datetime) –
      
      The timestamp when the finding was ingested.
    - scanRunId (string) –
      
      The scan that produced the finding, when it came from one. For a finding Continuum’s scanner produced, this is the Continuum scan run (see GetCodeScan). For a finding submitted with CreateCodeFinding, it is the OCSF document’s metadata.correlation_uid, when that value is a valid ScanRunId. Absent when the finding did not come from a scan.
    - statusMessage (string) –
      
      Human-readable context about the current status.
    - discardReason (string) –
      
      Why the finding was not escalated. Present only when status is DISCARDED.
    - discardReasoning (string) –
      
      Customer-facing explanation accompanying discardReason.
    - duplicateOfIssueId (string) –
      
      The existing issue this finding duplicates. Present only for the DUPLICATE_OF_* discard reasons.
    - createdIssueId (string) –
      
      The issue Continuum created from this finding.
    - completedAt (datetime) –
      
      When processing finished, whether by creating an issue or discarding. Absent while the finding is still in flight.
    - type (string) –
      
      What kind of finding this is.
    - title (string) –
      
      The producer’s title for the finding.
    - severity (string) –
      
      The finding’s severity.
    - category (string) –
      
      The producer’s vulnerability category.
    - filePath (string) –
      
      The file the finding is about, when it has a code location.
- nextToken (string) –
  
  A pagination token to retrieve the next page of results. Absent when there are no more results.

list_code_findings¶

Request Syntax

Response Syntax

Response Structure

Exceptions