aws_sdk_securityagent/client/update_threat.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 [`UpdateThreat`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`threat_id(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::threat_id) / [`set_threat_id(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_threat_id):<br>required: **true**<br><p>The unique identifier of the threat to update.</p><br>
7 /// - [`agent_space_id(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_agent_space_id):<br>required: **true**<br><p>The unique identifier of the agent space.</p><br>
8 /// - [`title(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::title) / [`set_title(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_title):<br>required: **false**<br><p>A short title summarizing the threat.</p><br>
9 /// - [`status(ThreatStatus)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::status) / [`set_status(Option<ThreatStatus>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_status):<br>required: **false**<br><p>The updated status of the threat.</p><br>
10 /// - [`comments(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::comments) / [`set_comments(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_comments):<br>required: **false**<br><p>Optional customer comment.</p><br>
11 /// - [`statement(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::statement) / [`set_statement(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_statement):<br>required: **false**<br><p>The updated natural-language threat statement.</p><br>
12 /// - [`severity(ThreatSeverity)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::severity) / [`set_severity(Option<ThreatSeverity>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_severity):<br>required: **false**<br><p>The updated severity level of the threat.</p><br>
13 /// - [`threat_source(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::threat_source) / [`set_threat_source(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_threat_source):<br>required: **false**<br><p>The updated actor or origin of the threat.</p><br>
14 /// - [`prerequisites(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::prerequisites) / [`set_prerequisites(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_prerequisites):<br>required: **false**<br><p>The updated conditions required for the threat to be exploitable.</p><br>
15 /// - [`threat_action(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::threat_action) / [`set_threat_action(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_threat_action):<br>required: **false**<br><p>The updated description of what the threat source can do.</p><br>
16 /// - [`threat_impact(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::threat_impact) / [`set_threat_impact(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_threat_impact):<br>required: **false**<br><p>The updated direct consequence of the threat action.</p><br>
17 /// - [`impacted_goal(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::impacted_goal) / [`set_impacted_goal(Option<Vec::<String>>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_impacted_goal):<br>required: **false**<br><p>The updated security goals affected by the threat.</p><br>
18 /// - [`impacted_assets(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::impacted_assets) / [`set_impacted_assets(Option<Vec::<String>>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_impacted_assets):<br>required: **false**<br><p>The updated list of specific assets affected by the threat.</p><br>
19 /// - [`anchor(ThreatAnchorShape)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::anchor) / [`set_anchor(Option<ThreatAnchorShape>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_anchor):<br>required: **false**<br><p>The updated DFD element this threat is anchored to.</p><br>
20 /// - [`evidence(ThreatEvidenceShape)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::evidence) / [`set_evidence(Option<Vec::<ThreatEvidenceShape>>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_evidence):<br>required: **false**<br><p>The updated source code files supporting the threat.</p><br>
21 /// - [`recommendation(impl Into<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::recommendation) / [`set_recommendation(Option<String>)`](crate::operation::update_threat::builders::UpdateThreatFluentBuilder::set_recommendation):<br>required: **false**<br><p>The updated recommended mitigation guidance for this threat.</p><br>
22 /// - On success, responds with [`UpdateThreatOutput`](crate::operation::update_threat::UpdateThreatOutput) with field(s):
23 /// - [`threat_id(String)`](crate::operation::update_threat::UpdateThreatOutput::threat_id): <p>The unique identifier of the threat.</p>
24 /// - [`threat_job_id(String)`](crate::operation::update_threat::UpdateThreatOutput::threat_job_id): <p>The unique identifier of the threat model job the threat belongs to.</p>
25 /// - [`title(Option<String>)`](crate::operation::update_threat::UpdateThreatOutput::title): <p>A short title summarizing the threat.</p>
26 /// - [`statement(Option<String>)`](crate::operation::update_threat::UpdateThreatOutput::statement): <p>The natural-language threat statement.</p>
27 /// - [`severity(Option<ThreatSeverity>)`](crate::operation::update_threat::UpdateThreatOutput::severity): <p>The severity level of the threat.</p>
28 /// - [`status(Option<ThreatStatus>)`](crate::operation::update_threat::UpdateThreatOutput::status): <p>The current status of the threat.</p>
29 /// - [`comments(Option<String>)`](crate::operation::update_threat::UpdateThreatOutput::comments): <p>Optional customer comment on the threat.</p>
30 /// - [`stride(Option<Vec::<StrideCategory>>)`](crate::operation::update_threat::UpdateThreatOutput::stride): <p>The STRIDE categories applicable to this threat.</p>
31 /// - [`threat_source(Option<String>)`](crate::operation::update_threat::UpdateThreatOutput::threat_source): <p>The actor or origin of the threat.</p>
32 /// - [`prerequisites(Option<String>)`](crate::operation::update_threat::UpdateThreatOutput::prerequisites): <p>The conditions required for the threat to be exploitable.</p>
33 /// - [`threat_action(Option<String>)`](crate::operation::update_threat::UpdateThreatOutput::threat_action): <p>What the threat source can do.</p>
34 /// - [`threat_impact(Option<String>)`](crate::operation::update_threat::UpdateThreatOutput::threat_impact): <p>The direct consequence of the threat action.</p>
35 /// - [`impacted_goal(Option<Vec::<String>>)`](crate::operation::update_threat::UpdateThreatOutput::impacted_goal): <p>The security goals affected by the threat.</p>
36 /// - [`impacted_assets(Option<Vec::<String>>)`](crate::operation::update_threat::UpdateThreatOutput::impacted_assets): <p>The specific assets affected by the threat.</p>
37 /// - [`anchor(Option<ThreatAnchorShape>)`](crate::operation::update_threat::UpdateThreatOutput::anchor): <p>The DFD element this threat is anchored to.</p>
38 /// - [`evidence(Option<Vec::<ThreatEvidenceShape>>)`](crate::operation::update_threat::UpdateThreatOutput::evidence): <p>The source code files supporting the threat.</p>
39 /// - [`recommendation(Option<String>)`](crate::operation::update_threat::UpdateThreatOutput::recommendation): <p>The recommended mitigation guidance for this threat.</p>
40 /// - [`created_by(Option<ThreatActor>)`](crate::operation::update_threat::UpdateThreatOutput::created_by): <p>Who created this threat.</p>
41 /// - [`updated_by(Option<ThreatActor>)`](crate::operation::update_threat::UpdateThreatOutput::updated_by): <p>Who last updated this threat.</p>
42 /// - [`created_at(Option<DateTime>)`](crate::operation::update_threat::UpdateThreatOutput::created_at): <p>The date and time the threat was created, in UTC format.</p>
43 /// - [`updated_at(Option<DateTime>)`](crate::operation::update_threat::UpdateThreatOutput::updated_at): <p>The date and time the threat was last updated, in UTC format.</p>
44 /// - On failure, responds with [`SdkError<UpdateThreatError>`](crate::operation::update_threat::UpdateThreatError)
45 pub fn update_threat(&self) -> crate::operation::update_threat::builders::UpdateThreatFluentBuilder {
46 crate::operation::update_threat::builders::UpdateThreatFluentBuilder::new(self.handle.clone())
47 }
48}