aws_sdk_securityagent/client/
create_threat_model.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 [`CreateThreatModel`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`title(impl Into<String>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::title) / [`set_title(Option<String>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::set_title):<br>required: **true**<br><p>The title of the threat model.</p><br>
7    ///   - [`agent_space_id(impl Into<String>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::set_agent_space_id):<br>required: **true**<br><p>The unique identifier of the agent space to create the threat model in.</p><br>
8    ///   - [`description(impl Into<String>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::set_description):<br>required: **false**<br><p>A description of the application or system being threat modeled.</p><br>
9    ///   - [`assets(Assets)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::assets) / [`set_assets(Option<Assets>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::set_assets):<br>required: **false**<br><p>The assets to include in the threat model.</p><br>
10    ///   - [`scope_docs(DocumentInfo)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::scope_docs) / [`set_scope_docs(Option<Vec::<DocumentInfo>>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::set_scope_docs):<br>required: **false**<br><p>The scoped documents for the agent to focus on during threat modeling.</p><br>
11    ///   - [`service_role(impl Into<String>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::service_role) / [`set_service_role(Option<String>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::set_service_role):<br>required: **true**<br><p>The IAM service role to use for the threat model.</p><br>
12    ///   - [`log_config(CloudWatchLog)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::log_config) / [`set_log_config(Option<CloudWatchLog>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::set_log_config):<br>required: **false**<br><p>The CloudWatch Logs configuration for the threat model.</p><br>
13    ///   - [`report_destination(ReportDestination)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::report_destination) / [`set_report_destination(Option<ReportDestination>)`](crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::set_report_destination):<br>required: **false**<br><p>The destination for publishing scan reports to an integrated document provider.</p><br>
14    /// - On success, responds with [`CreateThreatModelOutput`](crate::operation::create_threat_model::CreateThreatModelOutput) with field(s):
15    ///   - [`threat_model_id(String)`](crate::operation::create_threat_model::CreateThreatModelOutput::threat_model_id): <p>The unique identifier of the created threat model.</p>
16    ///   - [`title(Option<String>)`](crate::operation::create_threat_model::CreateThreatModelOutput::title): <p>The title of the threat model.</p>
17    ///   - [`agent_space_id(Option<String>)`](crate::operation::create_threat_model::CreateThreatModelOutput::agent_space_id): <p>The unique identifier of the agent space that contains the threat model.</p>
18    ///   - [`description(Option<String>)`](crate::operation::create_threat_model::CreateThreatModelOutput::description): <p>A description of the application or system being threat modeled.</p>
19    ///   - [`assets(Option<Assets>)`](crate::operation::create_threat_model::CreateThreatModelOutput::assets): <p>The assets included in the threat model.</p>
20    ///   - [`scope_docs(Option<Vec::<DocumentInfo>>)`](crate::operation::create_threat_model::CreateThreatModelOutput::scope_docs): <p>The scoped documents for the agent to focus on during threat modeling.</p>
21    ///   - [`service_role(Option<String>)`](crate::operation::create_threat_model::CreateThreatModelOutput::service_role): <p>The IAM service role used for the threat model.</p>
22    ///   - [`log_config(Option<CloudWatchLog>)`](crate::operation::create_threat_model::CreateThreatModelOutput::log_config): <p>The CloudWatch Logs configuration for the threat model.</p>
23    ///   - [`created_at(Option<DateTime>)`](crate::operation::create_threat_model::CreateThreatModelOutput::created_at): <p>The date and time the threat model was created, in UTC format.</p>
24    ///   - [`updated_at(Option<DateTime>)`](crate::operation::create_threat_model::CreateThreatModelOutput::updated_at): <p>The date and time the threat model was last updated, in UTC format.</p>
25    /// - On failure, responds with [`SdkError<CreateThreatModelError>`](crate::operation::create_threat_model::CreateThreatModelError)
26    pub fn create_threat_model(&self) -> crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder {
27        crate::operation::create_threat_model::builders::CreateThreatModelFluentBuilder::new(self.handle.clone())
28    }
29}
aws_sdk_securityagent/client/create_threat_model.rs

aws_sdk_securityagent/client/
create_threat_model.rs
