Skip to content

list_findings async

list_findings(
    agent_space_id: str,
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    pentest_job_id: Optional[str] = None,
    code_review_job_id: Optional[str] = None,
    next_token: Optional[NextToken] = None,
    risk_type: Optional[str] = None,
    risk_level: Optional[RiskLevel] = None,
    status: Optional[FindingStatus] = None,
    confidence: Optional[ConfidenceLevel] = None,
    name: Optional[str] = None,
) -> ListFindingsOutput

Lists the security findings for a pentest job.

Parameters:

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return in a single call.

  • pentest_job_id (Optional[str], default: None ) –

    The unique identifier of the pentest job to list findings for.

  • code_review_job_id (Optional[str], default: None ) –

    The unique identifier of the code review job to list findings for. Mutually exclusive with pentestJobId.

  • agent_space_id (str) –

    The unique identifier of the agent space.

  • next_token (Optional[NextToken], default: None ) –

    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.

  • risk_type (Optional[str], default: None ) –

    Filter findings by risk type.

  • risk_level (Optional[RiskLevel], default: None ) –

    Filter findings by risk level.

  • status (Optional[FindingStatus], default: None ) –

    Filter findings by status.

  • confidence (Optional[ConfidenceLevel], default: None ) –

    Filter findings by confidence level.

  • name (Optional[str], default: None ) –

    Filter findings by name.

Raises:

Source code in docs_src/capo_securityagent/_services/async_security_agent.py
async def list_findings(
    self,
    agent_space_id: str,
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    max_results: Optional["capo_securityagent.types.max_results.MaxResults"] = None,
    pentest_job_id: Optional[str] = None,
    code_review_job_id: Optional[str] = None,
    next_token: Optional["capo_securityagent.types.next_token.NextToken"] = None,
    risk_type: Optional[str] = None,
    risk_level: Optional["capo_securityagent.types.risk_level.RiskLevel"] = None,
    status: Optional[
        "capo_securityagent.types.finding_status.FindingStatus"
    ] = None,
    confidence: Optional[
        "capo_securityagent.types.confidence_level.ConfidenceLevel"
    ] = None,
    name: Optional[str] = None,
) -> "capo_securityagent.types.list_findings_output.ListFindingsOutput":
    """<p>Lists the security findings for a pentest job.</p>

    Args:
        max_results: <p>The maximum number of results to return in a single call.</p>
        pentest_job_id: <p>The unique identifier of the pentest job to list findings for.</p>
        code_review_job_id: <p>The unique identifier of the code review job to list findings for. Mutually exclusive with pentestJobId.</p>
        agent_space_id: <p>The unique identifier of the agent space.</p>
        next_token: <p>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.</p>
        risk_type: <p>Filter findings by risk type.</p>
        risk_level: <p>Filter findings by risk level.</p>
        status: <p>Filter findings by status.</p>
        confidence: <p>Filter findings by confidence level.</p>
        name: <p>Filter findings by name.</p>

    Raises:
        capo_securityagent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_securityagent.types.list_findings_input.ListFindingsInput]",
    ) -> AsyncOperationResponse[
        "capo_securityagent.types.list_findings_output.ListFindingsOutput"
    ]:
        import capo_securityagent._operations.security_agent.list_findings

        (
            output,
            http_response,
        ) = await capo_securityagent._operations.security_agent.list_findings.async_list_findings(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFindings")
    )
    input_: capo_securityagent.types.list_findings_input.ListFindingsInput = {
        "agent_space_id": agent_space_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if pentest_job_id is not None:
        input_["pentest_job_id"] = pentest_job_id
    if code_review_job_id is not None:
        input_["code_review_job_id"] = code_review_job_id
    if next_token is not None:
        input_["next_token"] = next_token
    if risk_type is not None:
        input_["risk_type"] = risk_type
    if risk_level is not None:
        input_["risk_level"] = risk_level
    if status is not None:
        input_["status"] = status
    if confidence is not None:
        input_["confidence"] = confidence
    if name is not None:
        input_["name"] = name

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output