aws_sdk_eventbridge/client/delete_rule.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 [`DeleteRule`](crate::operation::delete_rule::builders::DeleteRuleFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`name(impl Into<String>)`](crate::operation::delete_rule::builders::DeleteRuleFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::delete_rule::builders::DeleteRuleFluentBuilder::set_name):<br>required: **true**<br><p>The name of the rule.</p><br>
7 /// - [`event_bus_name(impl Into<String>)`](crate::operation::delete_rule::builders::DeleteRuleFluentBuilder::event_bus_name) / [`set_event_bus_name(Option<String>)`](crate::operation::delete_rule::builders::DeleteRuleFluentBuilder::set_event_bus_name):<br>required: **false**<br><p>The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.</p><br>
8 /// - [`force(bool)`](crate::operation::delete_rule::builders::DeleteRuleFluentBuilder::force) / [`set_force(Option<bool>)`](crate::operation::delete_rule::builders::DeleteRuleFluentBuilder::set_force):<br>required: **false**<br><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 delete the rule. 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><br>
9 /// - On success, responds with [`DeleteRuleOutput`](crate::operation::delete_rule::DeleteRuleOutput)
10 /// - On failure, responds with [`SdkError<DeleteRuleError>`](crate::operation::delete_rule::DeleteRuleError)
11 pub fn delete_rule(&self) -> crate::operation::delete_rule::builders::DeleteRuleFluentBuilder {
12 crate::operation::delete_rule::builders::DeleteRuleFluentBuilder::new(self.handle.clone())
13 }
14}