aws_sdk_securityagent/client/
start_pentest_job.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 [`StartPentestJob`](crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`agent_space_id(impl Into<String>)`](crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::agent_space_id) / [`set_agent_space_id(Option<String>)`](crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::set_agent_space_id):<br>required: **true**<br><p>The unique identifier of the agent space.</p><br>
7    ///   - [`pentest_id(impl Into<String>)`](crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::pentest_id) / [`set_pentest_id(Option<String>)`](crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::set_pentest_id):<br>required: **true**<br><p>The unique identifier of the pentest to start a job for.</p><br>
8    ///   - [`job_type(JobType)`](crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::job_type) / [`set_job_type(Option<JobType>)`](crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::set_job_type):<br>required: **false**<br><p>The type of pentest job to start. Valid values are FULL and REVALIDATION. When set to REVALIDATION, the selectedFindingIds parameter is required.</p><br>
9    ///   - [`selected_finding_ids(impl Into<String>)`](crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::selected_finding_ids) / [`set_selected_finding_ids(Option<Vec::<String>>)`](crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::set_selected_finding_ids):<br>required: **false**<br><p>The list of finding identifiers to revalidate. Required when jobType is REVALIDATION. Each finding must belong to the same agent space and pentest.</p><br>
10    /// - On success, responds with [`StartPentestJobOutput`](crate::operation::start_pentest_job::StartPentestJobOutput) with field(s):
11    ///   - [`title(Option<String>)`](crate::operation::start_pentest_job::StartPentestJobOutput::title): <p>The title of the pentest job.</p>
12    ///   - [`status(Option<JobStatus>)`](crate::operation::start_pentest_job::StartPentestJobOutput::status): <p>The current status of the pentest job.</p>
13    ///   - [`created_at(Option<DateTime>)`](crate::operation::start_pentest_job::StartPentestJobOutput::created_at): <p>The date and time the pentest job was created, in UTC format.</p>
14    ///   - [`updated_at(Option<DateTime>)`](crate::operation::start_pentest_job::StartPentestJobOutput::updated_at): <p>The date and time the pentest job was last updated, in UTC format.</p>
15    ///   - [`pentest_id(Option<String>)`](crate::operation::start_pentest_job::StartPentestJobOutput::pentest_id): <p>The unique identifier of the pentest.</p>
16    ///   - [`pentest_job_id(Option<String>)`](crate::operation::start_pentest_job::StartPentestJobOutput::pentest_job_id): <p>The unique identifier of the started pentest job.</p>
17    ///   - [`agent_space_id(Option<String>)`](crate::operation::start_pentest_job::StartPentestJobOutput::agent_space_id): <p>The unique identifier of the agent space.</p>
18    /// - On failure, responds with [`SdkError<StartPentestJobError>`](crate::operation::start_pentest_job::StartPentestJobError)
19    pub fn start_pentest_job(&self) -> crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder {
20        crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_securityagent/client/start_pentest_job.rs

aws_sdk_securityagent/client/
start_pentest_job.rs
