SecurityAgent / Client / batch_get_findings

batch_get_findings

SecurityAgent.Client.batch_get_findings(**kwargs)

Retrieves multiple findings in a single request

See also: AWS API Documentation

Request Syntax

response = client.batch_get_findings(
    findingIds=[
        'string',
    ],
    agentSpaceId='string'
)

Parameters:

• findingIds (list) –

  [REQUIRED]

  List of finding IDs to retrieve

  • (string) –

• agentSpaceId (string) –

  [REQUIRED]

  ID of the agent space where the findings exist

Return type:

dict

Returns:

Response Syntax

{
    'findings': [
        {
            'findingId': 'string',
            'agentSpaceId': 'string',
            'pentestId': 'string',
            'pentestJobId': 'string',
            'taskId': 'string',
            'name': 'string',
            'description': 'string',
            'status': 'ACTIVE'|'RESOLVED'|'ACCEPTED'|'FALSE_POSITIVE',
            'riskType': 'string',
            'riskLevel': 'UNKNOWN'|'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
            'riskScore': 'string',
            'reasoning': 'string',
            'confidence': 'FALSE_POSITIVE'|'UNCONFIRMED'|'LOW'|'MEDIUM'|'HIGH',
            'attackScript': 'string',
            'codeRemediationTask': {
                'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
                'statusReason': 'string',
                'taskDetails': [
                    {
                        'repoName': 'string',
                        'codeDiffLink': 'string',
                        'pullRequestLink': 'string'
                    },
                ]
            },
            'lastUpdatedBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

• (dict) –

  Output for the BatchGetFindings operation

  • findings (list) –

    List of successfully retrieved findings

    • (dict) –

      Represents a security vulnerability or issue discovered during testing

      • 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

      • taskId (string) –

        Identifier of the associated task

      • name (string) –

        Name or title of the finding

      • description (string) –

        Detailed description of the security vulnerability

      • status (string) –

        Current status of the finding

      • riskType (string) –

        Type of security risk identified

      • riskLevel (string) –

        Severity level of the identified risk

      • riskScore (string) –

        Risk score associated with the finding

      • reasoning (string) –

        Justification for the assigned risk score

      • confidence (string) –

        Confidence level of the finding

      • attackScript (string) –

        Proof-of-concept code demonstrating the vulnerability

      • codeRemediationTask (dict) –

        Code remediation task associated with this finding

        • status (string) –

          Current status of the code remediation task

        • statusReason (string) –

          Reason for the current code remediation task status

        • taskDetails (list) –

          Details of the code remediation for each repository

          • (dict) –

            Code remediation details for a single repository

            • repoName (string) –

              Name of the repository

            • codeDiffLink (string) –

              Link to the code diff for the remediation

            • pullRequestLink (string) –

              Link to the pull request for the remediation

      • lastUpdatedBy (string) –

        Identifier of the task or agent that last updated this finding

      • createdAt (datetime) –

        Timestamp when the finding was created

      • updatedAt (datetime) –

        Timestamp when the finding was last updated

  • notFound (list) –

    List of finding IDs that could not be found

    • (string) –