aws_sdk_eventbridge/operation/remove_targets/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::remove_targets::_remove_targets_output::RemoveTargetsOutputBuilder;
3
4pub use crate::operation::remove_targets::_remove_targets_input::RemoveTargetsInputBuilder;
5
6impl crate::operation::remove_targets::builders::RemoveTargetsInputBuilder {
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::remove_targets::RemoveTargetsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::remove_targets::RemoveTargetsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.remove_targets();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `RemoveTargets`.
24///
25/// <p>Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.</p><note>
26/// <p>A successful execution of <code>RemoveTargets</code> doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.</p>
27/// </note>
28/// <p>When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.</p>
29/// <p>This action can partially fail if too many requests are made at the same time. If that happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>
30/// <p>The maximum number of entries per request is 10.</p>
31#[derive(::std::clone::Clone, ::std::fmt::Debug)]
32pub struct RemoveTargetsFluentBuilder {
33    handle: ::std::sync::Arc<crate::client::Handle>,
34    inner: crate::operation::remove_targets::builders::RemoveTargetsInputBuilder,
35    config_override: ::std::option::Option<crate::config::Builder>,
36}
37impl
38    crate::client::customize::internal::CustomizableSend<
39        crate::operation::remove_targets::RemoveTargetsOutput,
40        crate::operation::remove_targets::RemoveTargetsError,
41    > for RemoveTargetsFluentBuilder
42{
43    fn send(
44        self,
45        config_override: crate::config::Builder,
46    ) -> crate::client::customize::internal::BoxFuture<
47        crate::client::customize::internal::SendResult<
48            crate::operation::remove_targets::RemoveTargetsOutput,
49            crate::operation::remove_targets::RemoveTargetsError,
50        >,
51    > {
52        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
53    }
54}
55impl RemoveTargetsFluentBuilder {
56    /// Creates a new `RemoveTargetsFluentBuilder`.
57    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
58        Self {
59            handle,
60            inner: ::std::default::Default::default(),
61            config_override: ::std::option::Option::None,
62        }
63    }
64    /// Access the RemoveTargets as a reference.
65    pub fn as_input(&self) -> &crate::operation::remove_targets::builders::RemoveTargetsInputBuilder {
66        &self.inner
67    }
68    /// Sends the request and returns the response.
69    ///
70    /// If an error occurs, an `SdkError` will be returned with additional details that
71    /// can be matched against.
72    ///
73    /// By default, any retryable failures will be retried twice. Retry behavior
74    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
75    /// set when configuring the client.
76    pub async fn send(
77        self,
78    ) -> ::std::result::Result<
79        crate::operation::remove_targets::RemoveTargetsOutput,
80        ::aws_smithy_runtime_api::client::result::SdkError<
81            crate::operation::remove_targets::RemoveTargetsError,
82            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
83        >,
84    > {
85        let input = self
86            .inner
87            .build()
88            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
89        let runtime_plugins = crate::operation::remove_targets::RemoveTargets::operation_runtime_plugins(
90            self.handle.runtime_plugins.clone(),
91            &self.handle.conf,
92            self.config_override,
93        );
94        crate::operation::remove_targets::RemoveTargets::orchestrate(&runtime_plugins, input).await
95    }
96
97    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
98    pub fn customize(
99        self,
100    ) -> crate::client::customize::CustomizableOperation<
101        crate::operation::remove_targets::RemoveTargetsOutput,
102        crate::operation::remove_targets::RemoveTargetsError,
103        Self,
104    > {
105        crate::client::customize::CustomizableOperation::new(self)
106    }
107    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
108        self.set_config_override(::std::option::Option::Some(config_override.into()));
109        self
110    }
111
112    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
113        self.config_override = config_override;
114        self
115    }
116    /// <p>The name of the rule.</p>
117    pub fn rule(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
118        self.inner = self.inner.rule(input.into());
119        self
120    }
121    /// <p>The name of the rule.</p>
122    pub fn set_rule(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
123        self.inner = self.inner.set_rule(input);
124        self
125    }
126    /// <p>The name of the rule.</p>
127    pub fn get_rule(&self) -> &::std::option::Option<::std::string::String> {
128        self.inner.get_rule()
129    }
130    /// <p>The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.</p>
131    pub fn event_bus_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
132        self.inner = self.inner.event_bus_name(input.into());
133        self
134    }
135    /// <p>The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.</p>
136    pub fn set_event_bus_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
137        self.inner = self.inner.set_event_bus_name(input);
138        self
139    }
140    /// <p>The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.</p>
141    pub fn get_event_bus_name(&self) -> &::std::option::Option<::std::string::String> {
142        self.inner.get_event_bus_name()
143    }
144    ///
145    /// Appends an item to `Ids`.
146    ///
147    /// To override the contents of this collection use [`set_ids`](Self::set_ids).
148    ///
149    /// <p>The IDs of the targets to remove from the rule.</p>
150    pub fn ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
151        self.inner = self.inner.ids(input.into());
152        self
153    }
154    /// <p>The IDs of the targets to remove from the rule.</p>
155    pub fn set_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
156        self.inner = self.inner.set_ids(input);
157        self
158    }
159    /// <p>The IDs of the targets to remove from the rule.</p>
160    pub fn get_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
161        self.inner.get_ids()
162    }
163    /// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify <code>Force</code> as <code>True</code> to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.</p>
164    pub fn force(mut self, input: bool) -> Self {
165        self.inner = self.inner.force(input);
166        self
167    }
168    /// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify <code>Force</code> as <code>True</code> to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.</p>
169    pub fn set_force(mut self, input: ::std::option::Option<bool>) -> Self {
170        self.inner = self.inner.set_force(input);
171        self
172    }
173    /// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify <code>Force</code> as <code>True</code> to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.</p>
174    pub fn get_force(&self) -> &::std::option::Option<bool> {
175        self.inner.get_force()
176    }
177}