Skip to main content

aws_sdk_securityagent/client/
list_threats.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`ListThreats`](crate::operation::list_threats::builders::ListThreatsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_threats::builders::ListThreatsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`threat_job_id(impl Into<String>)`](crate::operation::list_threats::builders::ListThreatsFluentBuilder::threat_job_id) / [`set_threat_job_id(Option<String>)`](crate::operation::list_threats::builders::ListThreatsFluentBuilder::set_threat_job_id):<br>required: **true**<br><p>The unique identifier of the threat model job to list threats for.</p><br>
8    ///   - [`agent_space_id(impl Into<String>)`](crate::operation::list_threats::builders::ListThreatsFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::list_threats::builders::ListThreatsFluentBuilder::set_agent_space_id):<br>required: **true**<br><p>The unique identifier of the agent space.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_threats::builders::ListThreatsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_threats::builders::ListThreatsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token to use for paginating results that are returned in the response.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_threats::builders::ListThreatsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_threats::builders::ListThreatsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
11    /// - On success, responds with [`ListThreatsOutput`](crate::operation::list_threats::ListThreatsOutput) with field(s):
12    ///   - [`threats(Option<Vec::<ThreatSummary>>)`](crate::operation::list_threats::ListThreatsOutput::threats): <p>The list of threat summaries.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_threats::ListThreatsOutput::next_token): <p>A token to use for paginating results that are returned in the response.</p>
14    /// - On failure, responds with [`SdkError<ListThreatsError>`](crate::operation::list_threats::ListThreatsError)
15    pub fn list_threats(&self) -> crate::operation::list_threats::builders::ListThreatsFluentBuilder {
16        crate::operation::list_threats::builders::ListThreatsFluentBuilder::new(self.handle.clone())
17    }
18}