Skip to content

list_threats async

list_threats(
    threat_job_id: str,
    agent_space_id: str,
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListThreatsOutput

Returns a paginated list of threats for a threat model job.

Parameters:

  • threat_job_id (str) –

    The unique identifier of the threat model job to list threats 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.

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

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

Raises:

Source code in docs_src/capo_securityagent/_services/async_security_agent.py
async def list_threats(
    self,
    threat_job_id: str,
    agent_space_id: str,
    *,
    config_overrides: Optional[AsyncSecurityAgentClientConfig] = None,
    next_token: Optional["capo_securityagent.types.next_token.NextToken"] = None,
    max_results: Optional["capo_securityagent.types.max_results.MaxResults"] = None,
) -> "capo_securityagent.types.list_threats_output.ListThreatsOutput":
    """<p>Returns a paginated list of threats for a threat model job.</p>

    Args:
        threat_job_id: <p>The unique identifier of the threat model job to list threats 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.</p>
        max_results: <p>The maximum number of results to return in a single call.</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_threats_input.ListThreatsInput]",
    ) -> AsyncOperationResponse[
        "capo_securityagent.types.list_threats_output.ListThreatsOutput"
    ]:
        import capo_securityagent._operations.security_agent.list_threats

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListThreats")
    )
    input_: capo_securityagent.types.list_threats_input.ListThreatsInput = {
        "threat_job_id": threat_job_id,
        "agent_space_id": agent_space_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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