aws_sdk_eventbridge/client/
list_rules.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListRules`](crate::operation::list_rules::builders::ListRulesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name_prefix(impl Into<String>)`](crate::operation::list_rules::builders::ListRulesFluentBuilder::name_prefix) / [`set_name_prefix(Option<String>)`](crate::operation::list_rules::builders::ListRulesFluentBuilder::set_name_prefix):<br>required: **false**<br><p>The prefix matching the rule name.</p><br>
    ///   - [`event_bus_name(impl Into<String>)`](crate::operation::list_rules::builders::ListRulesFluentBuilder::event_bus_name) / [`set_event_bus_name(Option<String>)`](crate::operation::list_rules::builders::ListRulesFluentBuilder::set_event_bus_name):<br>required: **false**<br><p>The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_rules::builders::ListRulesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_rules::builders::ListRulesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token returned by a previous call to retrieve the next set of results.</p><br>
    ///   - [`limit(i32)`](crate::operation::list_rules::builders::ListRulesFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_rules::builders::ListRulesFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
    /// - On success, responds with [`ListRulesOutput`](crate::operation::list_rules::ListRulesOutput) with field(s):
    ///   - [`rules(Option<Vec::<Rule>>)`](crate::operation::list_rules::ListRulesOutput::rules): <p>The rules that match the specified criteria.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_rules::ListRulesOutput::next_token): <p>Indicates whether there are additional results to retrieve. If there are no more results, the value is null.</p>
    /// - On failure, responds with [`SdkError<ListRulesError>`](crate::operation::list_rules::ListRulesError)
    pub fn list_rules(&self) -> crate::operation::list_rules::builders::ListRulesFluentBuilder {
        crate::operation::list_rules::builders::ListRulesFluentBuilder::new(self.handle.clone())
    }
}