list_pentest_job_tasks `async` ¶

list_pentest_job_tasks(
    agent_space_id: str,
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    pentest_job_id: Optional[str] = None,
    step_name: Optional[StepName] = None,
    category_name: Optional[str] = None,
    next_token: Optional[NextToken] = None,
) -> ListPentestJobTasksOutput

Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.

Parameters:

agent_space_id (str) –

The unique identifier of the agent space.
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 tasks for.
step_name (Optional[StepName], default: None ) –

Filter tasks by step name. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING.
category_name (Optional[str], default: None ) –

Filter tasks by category name.
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.

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_job_tasks(
    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,
    step_name: Optional["capo_securityagent.types.step_name.StepName"] = None,
    category_name: Optional[str] = None,
    next_token: Optional["capo_securityagent.types.next_token.NextToken"] = None,
) -> "capo_securityagent.types.list_pentest_job_tasks_output.ListPentestJobTasksOutput":
    """<p>Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.</p>

    Args:
        agent_space_id: <p>The unique identifier of the agent space.</p>
        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 tasks for.</p>
        step_name: <p>Filter tasks by step name. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING.</p>
        category_name: <p>Filter tasks by category name.</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>

    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_job_tasks_input.ListPentestJobTasksInput]",
    ) -> AsyncOperationResponse[
        "capo_securityagent.types.list_pentest_job_tasks_output.ListPentestJobTasksOutput"
    ]:
        import capo_securityagent._operations.security_agent.list_pentest_job_tasks

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPentestJobTasks")
    )
    input_: capo_securityagent.types.list_pentest_job_tasks_input.ListPentestJobTasksInput = {
        "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 step_name is not None:
        input_["step_name"] = step_name
    if category_name is not None:
        input_["category_name"] = category_name
    if next_token is not None:
        input_["next_token"] = next_token

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

list_pentest_job_tasks async ¶

list_pentest_job_tasks `async` ¶