Skip to main content

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>ID of the agent space where the pentest exists<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>Identifier of the pentest to execute<br>
8    /// - On success, responds with [`StartPentestJobOutput`](crate::operation::start_pentest_job::StartPentestJobOutput) with field(s):
9    ///   - [`title(Option<String>)`](crate::operation::start_pentest_job::StartPentestJobOutput::title): Title of the pentest job
10    ///   - [`status(Option<JobStatus>)`](crate::operation::start_pentest_job::StartPentestJobOutput::status): Current status of the pentest job
11    ///   - [`created_at(Option<DateTime>)`](crate::operation::start_pentest_job::StartPentestJobOutput::created_at): Timestamp when the pentest job was created
12    ///   - [`updated_at(Option<DateTime>)`](crate::operation::start_pentest_job::StartPentestJobOutput::updated_at): Timestamp when the pentest job was last updated
13    ///   - [`pentest_id(Option<String>)`](crate::operation::start_pentest_job::StartPentestJobOutput::pentest_id): Unique identifier of the pentest
14    ///   - [`pentest_job_id(Option<String>)`](crate::operation::start_pentest_job::StartPentestJobOutput::pentest_job_id): Unique identifier of the pentest job
15    ///   - [`agent_space_id(Option<String>)`](crate::operation::start_pentest_job::StartPentestJobOutput::agent_space_id): ID of the agent space where the pentest exists
16    /// - On failure, responds with [`SdkError<StartPentestJobError>`](crate::operation::start_pentest_job::StartPentestJobError)
17    pub fn start_pentest_job(&self) -> crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder {
18        crate::operation::start_pentest_job::builders::StartPentestJobFluentBuilder::new(self.handle.clone())
19    }
20}