Skip to content

batch_get_pentest_jobs

batch_get_pentest_jobs(
    pentest_job_ids: PentestJobIdList,
    agent_space_id: str,
    *,
    config_overrides: Optional[SecurityAgentClientConfig] = None,
) -> BatchGetPentestJobsOutput

Retrieves information about one or more pentest jobs in an agent space.

Parameters:

  • pentest_job_ids (PentestJobIdList) –

    The list of pentest job identifiers to retrieve.

  • agent_space_id (str) –

    The unique identifier of the agent space that contains the pentest jobs.

Raises:

Source code in docs_src/capo_securityagent/_services/security_agent.py
def batch_get_pentest_jobs(
    self,
    pentest_job_ids: "capo_securityagent.types.pentest_job_id_list.PentestJobIdList",
    agent_space_id: str,
    *,
    config_overrides: Optional[SecurityAgentClientConfig] = None,
) -> "capo_securityagent.types.batch_get_pentest_jobs_output.BatchGetPentestJobsOutput":
    """<p>Retrieves information about one or more pentest jobs in an agent space.</p>

    Args:
        pentest_job_ids: <p>The list of pentest job identifiers to retrieve.</p>
        agent_space_id: <p>The unique identifier of the agent space that contains the pentest jobs.</p>

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

    def _handler(
        req: "OperationRequest[capo_securityagent.types.batch_get_pentest_jobs_input.BatchGetPentestJobsInput]",
    ) -> OperationResponse[
        "capo_securityagent.types.batch_get_pentest_jobs_output.BatchGetPentestJobsOutput"
    ]:
        import capo_securityagent._operations.security_agent.batch_get_pentest_jobs

        output, http_response = (
            capo_securityagent._operations.security_agent.batch_get_pentest_jobs.batch_get_pentest_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_securityagent.types.batch_get_pentest_jobs_output.BatchGetPentestJobsOutput",
    ) -> dict[str, Any]:
        import capo_securityagent.types.batch_get_pentest_jobs_output

        return (
            capo_securityagent.types.batch_get_pentest_jobs_output.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("BatchGetPentestJobs", redact_output=_redact_output),
    )
    input_: capo_securityagent.types.batch_get_pentest_jobs_input.BatchGetPentestJobsInput = {
        "pentest_job_ids": pentest_job_ids,
        "agent_space_id": agent_space_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output