list_pentest_jobs_for_pentest `async` ¶

list_pentest_jobs_for_pentest(
    pentest_id: str,
    agent_space_id: str,
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
    job_type: Optional[JobType] = None,
) -> ListPentestJobsForPentestOutput

Returns a paginated list of pentest job summaries for the specified pentest configuration.

Parameters:

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

The maximum number of results to return in a single call.
pentest_id (str) –

The unique identifier of the pentest to list jobs for.
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.
job_type (Optional[JobType], default: None ) –

Filters the returned pentest jobs to only those of the specified job type.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_securityagent/_services/async_security_agent.py

async def list_pentest_jobs_for_pentest(
    self,
    pentest_id: str,
    agent_space_id: str,
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    max_results: Optional["capo_securityagent.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_securityagent.types.next_token.NextToken"] = None,
    job_type: Optional["capo_securityagent.types.job_type.JobType"] = None,
) -> "capo_securityagent.types.list_pentest_jobs_for_pentest_output.ListPentestJobsForPentestOutput":
    """<p>Returns a paginated list of pentest job summaries for the specified pentest configuration.</p>

    Args:
        max_results: <p>The maximum number of results to return in a single call.</p>
        pentest_id: <p>The unique identifier of the pentest to list jobs for.</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>
        job_type: <p>Filters the returned pentest jobs to only those of the specified job type.</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_pentest_jobs_for_pentest_input.ListPentestJobsForPentestInput]",
    ) -> AsyncOperationResponse[
        "capo_securityagent.types.list_pentest_jobs_for_pentest_output.ListPentestJobsForPentestOutput"
    ]:
        import capo_securityagent._operations.security_agent.list_pentest_jobs_for_pentest

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPentestJobsForPentest")
    )
    input_: capo_securityagent.types.list_pentest_jobs_for_pentest_input.ListPentestJobsForPentestInput = {
        "pentest_id": pentest_id,
        "agent_space_id": agent_space_id,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if job_type is not None:
        input_["job_type"] = job_type

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

list_pentest_jobs_for_pentest async ¶

list_pentest_jobs_for_pentest `async` ¶