aws_sdk_securityagent/client/

create_threat.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateThreat`](crate::operation::create_threat::builders::CreateThreatFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`agent_space_id(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_agent_space_id):<br>required: **true**<br><p>The unique identifier of the agent space.</p><br>
    ///   - [`threat_job_id(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::threat_job_id) / [`set_threat_job_id(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_threat_job_id):<br>required: **true**<br><p>The unique identifier of the threat model job the threat belongs to.</p><br>
    ///   - [`title(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::title) / [`set_title(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_title):<br>required: **false**<br><p>A short title summarizing the threat.</p><br>
    ///   - [`statement(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::statement) / [`set_statement(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_statement):<br>required: **false**<br><p>The natural-language threat statement.</p><br>
    ///   - [`severity(ThreatSeverity)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::severity) / [`set_severity(Option<ThreatSeverity>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_severity):<br>required: **false**<br><p>The severity level of the threat.</p><br>
    ///   - [`comments(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::comments) / [`set_comments(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_comments):<br>required: **false**<br><p>Optional customer comment on the threat.</p><br>
    ///   - [`stride(StrideCategory)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::stride) / [`set_stride(Option<Vec::<StrideCategory>>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_stride):<br>required: **false**<br><p>The STRIDE categories applicable to this threat.</p><br>
    ///   - [`threat_source(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::threat_source) / [`set_threat_source(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_threat_source):<br>required: **false**<br><p>The actor or origin of the threat.</p><br>
    ///   - [`prerequisites(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::prerequisites) / [`set_prerequisites(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_prerequisites):<br>required: **false**<br><p>The conditions required for the threat to be exploitable.</p><br>
    ///   - [`threat_action(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::threat_action) / [`set_threat_action(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_threat_action):<br>required: **false**<br><p>What the threat source can do.</p><br>
    ///   - [`threat_impact(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::threat_impact) / [`set_threat_impact(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_threat_impact):<br>required: **false**<br><p>The direct consequence of the threat action.</p><br>
    ///   - [`impacted_goal(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::impacted_goal) / [`set_impacted_goal(Option<Vec::<String>>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_impacted_goal):<br>required: **false**<br><p>The security goals affected by the threat.</p><br>
    ///   - [`impacted_assets(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::impacted_assets) / [`set_impacted_assets(Option<Vec::<String>>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_impacted_assets):<br>required: **false**<br><p>The specific assets affected by the threat.</p><br>
    ///   - [`anchor(ThreatAnchorShape)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::anchor) / [`set_anchor(Option<ThreatAnchorShape>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_anchor):<br>required: **false**<br><p>The DFD element this threat is anchored to.</p><br>
    ///   - [`evidence(ThreatEvidenceShape)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::evidence) / [`set_evidence(Option<Vec::<ThreatEvidenceShape>>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_evidence):<br>required: **false**<br><p>The source code files supporting the threat.</p><br>
    ///   - [`recommendation(impl Into<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::recommendation) / [`set_recommendation(Option<String>)`](crate::operation::create_threat::builders::CreateThreatFluentBuilder::set_recommendation):<br>required: **false**<br><p>The recommended mitigation guidance for this threat.</p><br>
    /// - On success, responds with [`CreateThreatOutput`](crate::operation::create_threat::CreateThreatOutput) with field(s):
    ///   - [`threat_id(String)`](crate::operation::create_threat::CreateThreatOutput::threat_id): <p>The unique identifier of the created threat.</p>
    ///   - [`threat_job_id(String)`](crate::operation::create_threat::CreateThreatOutput::threat_job_id): <p>The unique identifier of the threat model job the threat belongs to.</p>
    ///   - [`title(Option<String>)`](crate::operation::create_threat::CreateThreatOutput::title): <p>A short title summarizing the threat.</p>
    ///   - [`statement(Option<String>)`](crate::operation::create_threat::CreateThreatOutput::statement): <p>The natural-language threat statement.</p>
    ///   - [`severity(Option<ThreatSeverity>)`](crate::operation::create_threat::CreateThreatOutput::severity): <p>The severity level of the threat.</p>
    ///   - [`status(Option<ThreatStatus>)`](crate::operation::create_threat::CreateThreatOutput::status): <p>The current status of the threat.</p>
    ///   - [`comments(Option<String>)`](crate::operation::create_threat::CreateThreatOutput::comments): <p>Optional customer comment on the threat.</p>
    ///   - [`stride(Option<Vec::<StrideCategory>>)`](crate::operation::create_threat::CreateThreatOutput::stride): <p>The STRIDE categories applicable to this threat.</p>
    ///   - [`threat_source(Option<String>)`](crate::operation::create_threat::CreateThreatOutput::threat_source): <p>The actor or origin of the threat.</p>
    ///   - [`prerequisites(Option<String>)`](crate::operation::create_threat::CreateThreatOutput::prerequisites): <p>The conditions required for the threat to be exploitable.</p>
    ///   - [`threat_action(Option<String>)`](crate::operation::create_threat::CreateThreatOutput::threat_action): <p>What the threat source can do.</p>
    ///   - [`threat_impact(Option<String>)`](crate::operation::create_threat::CreateThreatOutput::threat_impact): <p>The direct consequence of the threat action.</p>
    ///   - [`impacted_goal(Option<Vec::<String>>)`](crate::operation::create_threat::CreateThreatOutput::impacted_goal): <p>The security goals affected by the threat.</p>
    ///   - [`impacted_assets(Option<Vec::<String>>)`](crate::operation::create_threat::CreateThreatOutput::impacted_assets): <p>The specific assets affected by the threat.</p>
    ///   - [`anchor(Option<ThreatAnchorShape>)`](crate::operation::create_threat::CreateThreatOutput::anchor): <p>The DFD element this threat is anchored to.</p>
    ///   - [`evidence(Option<Vec::<ThreatEvidenceShape>>)`](crate::operation::create_threat::CreateThreatOutput::evidence): <p>The source code files supporting the threat.</p>
    ///   - [`recommendation(Option<String>)`](crate::operation::create_threat::CreateThreatOutput::recommendation): <p>The recommended mitigation guidance for this threat.</p>
    ///   - [`created_by(Option<ThreatActor>)`](crate::operation::create_threat::CreateThreatOutput::created_by): <p>Who created this threat.</p>
    ///   - [`updated_by(Option<ThreatActor>)`](crate::operation::create_threat::CreateThreatOutput::updated_by): <p>Who last updated this threat.</p>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::create_threat::CreateThreatOutput::created_at): <p>The date and time the threat was created, in UTC format.</p>
    ///   - [`updated_at(Option<DateTime>)`](crate::operation::create_threat::CreateThreatOutput::updated_at): <p>The date and time the threat was last updated, in UTC format.</p>
    /// - On failure, responds with [`SdkError<CreateThreatError>`](crate::operation::create_threat::CreateThreatError)
    pub fn create_threat(&self) -> crate::operation::create_threat::builders::CreateThreatFluentBuilder {
        crate::operation::create_threat::builders::CreateThreatFluentBuilder::new(self.handle.clone())
    }
}