Skip to content

start_code_remediation async

start_code_remediation(
    agent_space_id: str,
    finding_ids: FindingIdList,
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    pentest_job_id: Optional[str] = None,
    code_review_job_id: Optional[str] = None,
) -> StartCodeRemediationOutput

Initiates code remediation for one or more security findings. This creates pull requests in integrated repositories to fix the identified vulnerabilities.

Parameters:

  • agent_space_id (str) –

    The unique identifier of the agent space.

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

    The unique identifier of the pentest job that produced the findings. Mutually exclusive with codeReviewJobId.

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

    The unique identifier of the code review job that produced the findings. Mutually exclusive with pentestJobId.

  • finding_ids (FindingIdList) –

    The list of finding identifiers to initiate code remediation for.

Raises:

Source code in docs_src/capo_securityagent/_services/async_security_agent.py
async def start_code_remediation(
    self,
    agent_space_id: str,
    finding_ids: "capo_securityagent.types.finding_id_list.FindingIdList",
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    pentest_job_id: Optional[str] = None,
    code_review_job_id: Optional[str] = None,
) -> "capo_securityagent.types.start_code_remediation_output.StartCodeRemediationOutput":
    """<p>Initiates code remediation for one or more security findings. This creates pull requests in integrated repositories to fix the identified vulnerabilities.</p>

    Args:
        agent_space_id: <p>The unique identifier of the agent space.</p>
        pentest_job_id: <p>The unique identifier of the pentest job that produced the findings. Mutually exclusive with <code>codeReviewJobId</code>.</p>
        code_review_job_id: <p>The unique identifier of the code review job that produced the findings. Mutually exclusive with <code>pentestJobId</code>.</p>
        finding_ids: <p>The list of finding identifiers to initiate code remediation for.</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.start_code_remediation_input.StartCodeRemediationInput]",
    ) -> AsyncOperationResponse[
        "capo_securityagent.types.start_code_remediation_output.StartCodeRemediationOutput"
    ]:
        import capo_securityagent._operations.security_agent.start_code_remediation

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartCodeRemediation")
    )
    input_: capo_securityagent.types.start_code_remediation_input.StartCodeRemediationInput = {
        "agent_space_id": agent_space_id,
        "finding_ids": finding_ids,
    }
    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

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