aws_sdk_appflow/operation/cancel_flow_executions/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::cancel_flow_executions::_cancel_flow_executions_output::CancelFlowExecutionsOutputBuilder;
3
4pub use crate::operation::cancel_flow_executions::_cancel_flow_executions_input::CancelFlowExecutionsInputBuilder;
5
6impl crate::operation::cancel_flow_executions::builders::CancelFlowExecutionsInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::cancel_flow_executions::CancelFlowExecutionsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::cancel_flow_executions::CancelFlowExecutionsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.cancel_flow_executions();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CancelFlowExecutions`.
24///
25/// <p>Cancels active runs for a flow.</p>
26/// <p>You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs.</p>
27/// <p>You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the <code>StopFlow</code> action.</p>
28/// <p>You cannot resume a run after you cancel it.</p>
29/// <p>When you send your request, the status for each run becomes <code>CancelStarted</code>. When the cancellation completes, the status becomes <code>Canceled</code>.</p><note>
30/// <p>When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see <a href="http://aws.amazon.com/appflow/pricing/">Amazon AppFlow pricing</a>.</p>
31/// </note>
32#[derive(::std::clone::Clone, ::std::fmt::Debug)]
33pub struct CancelFlowExecutionsFluentBuilder {
34    handle: ::std::sync::Arc<crate::client::Handle>,
35    inner: crate::operation::cancel_flow_executions::builders::CancelFlowExecutionsInputBuilder,
36    config_override: ::std::option::Option<crate::config::Builder>,
37}
38impl
39    crate::client::customize::internal::CustomizableSend<
40        crate::operation::cancel_flow_executions::CancelFlowExecutionsOutput,
41        crate::operation::cancel_flow_executions::CancelFlowExecutionsError,
42    > for CancelFlowExecutionsFluentBuilder
43{
44    fn send(
45        self,
46        config_override: crate::config::Builder,
47    ) -> crate::client::customize::internal::BoxFuture<
48        crate::client::customize::internal::SendResult<
49            crate::operation::cancel_flow_executions::CancelFlowExecutionsOutput,
50            crate::operation::cancel_flow_executions::CancelFlowExecutionsError,
51        >,
52    > {
53        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
54    }
55}
56impl CancelFlowExecutionsFluentBuilder {
57    /// Creates a new `CancelFlowExecutionsFluentBuilder`.
58    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
59        Self {
60            handle,
61            inner: ::std::default::Default::default(),
62            config_override: ::std::option::Option::None,
63        }
64    }
65    /// Access the CancelFlowExecutions as a reference.
66    pub fn as_input(&self) -> &crate::operation::cancel_flow_executions::builders::CancelFlowExecutionsInputBuilder {
67        &self.inner
68    }
69    /// Sends the request and returns the response.
70    ///
71    /// If an error occurs, an `SdkError` will be returned with additional details that
72    /// can be matched against.
73    ///
74    /// By default, any retryable failures will be retried twice. Retry behavior
75    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
76    /// set when configuring the client.
77    pub async fn send(
78        self,
79    ) -> ::std::result::Result<
80        crate::operation::cancel_flow_executions::CancelFlowExecutionsOutput,
81        ::aws_smithy_runtime_api::client::result::SdkError<
82            crate::operation::cancel_flow_executions::CancelFlowExecutionsError,
83            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
84        >,
85    > {
86        let input = self
87            .inner
88            .build()
89            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
90        let runtime_plugins = crate::operation::cancel_flow_executions::CancelFlowExecutions::operation_runtime_plugins(
91            self.handle.runtime_plugins.clone(),
92            &self.handle.conf,
93            self.config_override,
94        );
95        crate::operation::cancel_flow_executions::CancelFlowExecutions::orchestrate(&runtime_plugins, input).await
96    }
97
98    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
99    pub fn customize(
100        self,
101    ) -> crate::client::customize::CustomizableOperation<
102        crate::operation::cancel_flow_executions::CancelFlowExecutionsOutput,
103        crate::operation::cancel_flow_executions::CancelFlowExecutionsError,
104        Self,
105    > {
106        crate::client::customize::CustomizableOperation::new(self)
107    }
108    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
109        self.set_config_override(::std::option::Option::Some(config_override.into()));
110        self
111    }
112
113    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
114        self.config_override = config_override;
115        self
116    }
117    /// <p>The name of a flow with active runs that you want to cancel.</p>
118    pub fn flow_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.flow_name(input.into());
120        self
121    }
122    /// <p>The name of a flow with active runs that you want to cancel.</p>
123    pub fn set_flow_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_flow_name(input);
125        self
126    }
127    /// <p>The name of a flow with active runs that you want to cancel.</p>
128    pub fn get_flow_name(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_flow_name()
130    }
131    ///
132    /// Appends an item to `executionIds`.
133    ///
134    /// To override the contents of this collection use [`set_execution_ids`](Self::set_execution_ids).
135    ///
136    /// <p>The ID of each active run to cancel. These runs must belong to the flow you specify in your request.</p>
137    /// <p>If you omit this parameter, your request ends all active runs that belong to the flow.</p>
138    pub fn execution_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
139        self.inner = self.inner.execution_ids(input.into());
140        self
141    }
142    /// <p>The ID of each active run to cancel. These runs must belong to the flow you specify in your request.</p>
143    /// <p>If you omit this parameter, your request ends all active runs that belong to the flow.</p>
144    pub fn set_execution_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
145        self.inner = self.inner.set_execution_ids(input);
146        self
147    }
148    /// <p>The ID of each active run to cancel. These runs must belong to the flow you specify in your request.</p>
149    /// <p>If you omit this parameter, your request ends all active runs that belong to the flow.</p>
150    pub fn get_execution_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
151        self.inner.get_execution_ids()
152    }
153}
aws_sdk_appflow/operation/cancel_flow_executions/builders.rs

aws_sdk_appflow/operation/cancel_flow_executions/
builders.rs
