aws_sdk_continuum/waiters/
code_scan_succeeded.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2
3///
4/// Fluent builder for the `code_scan_succeeded` waiter.
5///
6/// This builder is intended to be used similar to the other fluent builders for
7/// normal operations on the client. However, instead of a `send` method, it has
8/// a `wait` method that takes a maximum amount of time to wait.
9///
10/// Construct this fluent builder using the client by importing the
11/// [`Waiters`](crate::client::Waiters) trait and calling the methods
12/// prefixed with `wait_until`.
13///
14#[derive(::std::clone::Clone, ::std::fmt::Debug)]
15pub struct CodeScanSucceededFluentBuilder {
16    handle: ::std::sync::Arc<crate::client::Handle>,
17    inner: crate::operation::get_code_scan::builders::GetCodeScanInputBuilder,
18}
19impl CodeScanSucceededFluentBuilder {
20    /// Creates a new `CodeScanSucceededFluentBuilder`.
21    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
22        Self {
23            handle,
24            inner: ::std::default::Default::default(),
25        }
26    }
27    /// Access the GetCodeScan as a reference.
28    pub fn as_input(&self) -> &crate::operation::get_code_scan::builders::GetCodeScanInputBuilder {
29        &self.inner
30    }
31    /// Waits until the scan reaches SUCCEEDED, at which point the scan has finished and its findings are available from ListCodeFindings (filter on scanRunId). Triage of those findings and creation of issues continue asynchronously after the scan succeeds. Fails if the scan reaches FAILED. Scans run a build followed by analysis and can take from minutes to several hours. SDKs that use exponential backoff wait at least 60 seconds between polls and back off to at most 8 hours between polls, until the caller's maximum wait time elapses. SDKs and the AWS CLI that use a fixed delay poll every 60 seconds for up to 480 attempts (8 hours).
32    pub async fn wait(
33        self,
34        max_wait: ::std::time::Duration,
35    ) -> ::std::result::Result<
36        crate::waiters::code_scan_succeeded::CodeScanSucceededFinalPoll,
37        crate::waiters::code_scan_succeeded::WaitUntilCodeScanSucceededError,
38    > {
39        let input = self
40            .inner
41            .build()
42            .map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
43        let runtime_plugins = crate::operation::get_code_scan::GetCodeScan::operation_runtime_plugins(
44            self.handle.runtime_plugins.clone(),
45            &self.handle.conf,
46            ::std::option::Option::None,
47        )
48        .with_operation_plugin(crate::sdk_feature_tracker::waiter::WaiterFeatureTrackerRuntimePlugin::new());
49        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
50        let runtime_components_builder = runtime_plugins
51            .apply_client_configuration(&mut cfg)
52            .map_err(::aws_smithy_runtime_api::client::waiters::error::WaiterError::construction_failure)?;
53        let time_components = runtime_components_builder.into_time_components();
54        let sleep_impl = time_components.sleep_impl().expect("a sleep impl is required by waiters");
55        let time_source = time_components.time_source().expect("a time source is required by waiters");
56
57        let acceptor = move |result: ::std::result::Result<
58            &crate::operation::get_code_scan::GetCodeScanOutput,
59            &crate::operation::get_code_scan::GetCodeScanError,
60        >| {
61            // Matches: {"output":{"path":"scan.status","expected":"SUCCEEDED","comparator":"stringEquals"}}
62            if crate::waiters::matchers::match_get_code_scan_f918c82199f968f0f(result) {
63                return ::aws_smithy_runtime::client::waiters::AcceptorState::Success;
64            }
65            // Matches: {"output":{"path":"scan.status","expected":"FAILED","comparator":"stringEquals"}}
66            if crate::waiters::matchers::match_get_code_scan_a1e0cf5c46c81da94(result) {
67                return ::aws_smithy_runtime::client::waiters::AcceptorState::Failure;
68            }
69            ::aws_smithy_runtime::client::waiters::AcceptorState::NoAcceptorsMatched
70        };
71        let operation = move || {
72            let input = input.clone();
73            let runtime_plugins = runtime_plugins.clone();
74            async move { crate::operation::get_code_scan::GetCodeScan::orchestrate(&runtime_plugins, input).await }
75        };
76        let orchestrator = ::aws_smithy_runtime::client::waiters::WaiterOrchestrator::builder()
77            .min_delay(::std::time::Duration::from_secs(60))
78            .max_delay(::std::time::Duration::from_secs(28800))
79            .max_wait(max_wait)
80            .time_source(time_source)
81            .sleep_impl(sleep_impl)
82            .acceptor(acceptor)
83            .operation(operation)
84            .build();
85        ::aws_smithy_runtime::client::waiters::attach_waiter_tracing_span(orchestrator.orchestrate()).await
86    }
87    /// Environment that owns the scan.
88    pub fn environment_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
89        self.inner = self.inner.environment_id(input.into());
90        self
91    }
92    /// Environment that owns the scan.
93    pub fn set_environment_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
94        self.inner = self.inner.set_environment_id(input);
95        self
96    }
97    /// Environment that owns the scan.
98    pub fn get_environment_id(&self) -> &::std::option::Option<::std::string::String> {
99        self.inner.get_environment_id()
100    }
101    /// Scan to retrieve.
102    pub fn scan_run_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
103        self.inner = self.inner.scan_run_id(input.into());
104        self
105    }
106    /// Scan to retrieve.
107    pub fn set_scan_run_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
108        self.inner = self.inner.set_scan_run_id(input);
109        self
110    }
111    /// Scan to retrieve.
112    pub fn get_scan_run_id(&self) -> &::std::option::Option<::std::string::String> {
113        self.inner.get_scan_run_id()
114    }
115}
116
117/// Successful return type for the `code_scan_succeeded` waiter.
118pub type CodeScanSucceededFinalPoll = ::aws_smithy_runtime_api::client::waiters::FinalPoll<
119    crate::operation::get_code_scan::GetCodeScanOutput,
120    ::aws_smithy_runtime_api::client::result::SdkError<
121        crate::operation::get_code_scan::GetCodeScanError,
122        ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
123    >,
124>;
125
126/// Error type for the `code_scan_succeeded` waiter.
127pub type WaitUntilCodeScanSucceededError = ::aws_smithy_runtime_api::client::waiters::error::WaiterError<
128    crate::operation::get_code_scan::GetCodeScanOutput,
129    crate::operation::get_code_scan::GetCodeScanError,
130>;
aws_sdk_continuum/waiters/code_scan_succeeded.rs

aws_sdk_continuum/waiters/
code_scan_succeeded.rs
