aws_sdk_eventbridge/client/
list_rules.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 [`ListRules`](crate::operation::list_rules::builders::ListRulesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`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>
7    ///   - [`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>
8    ///   - [`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, which you can use to retrieve the next set of results.</p> <p>The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.</p> <p>Using an expired pagination token results in an <code>HTTP 400 InvalidToken</code> error.</p><br>
9    ///   - [`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>
10    /// - On success, responds with [`ListRulesOutput`](crate::operation::list_rules::ListRulesOutput) with field(s):
11    ///   - [`rules(Option<Vec::<Rule>>)`](crate::operation::list_rules::ListRulesOutput::rules): <p>The rules that match the specified criteria.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_rules::ListRulesOutput::next_token): <p>A token indicating there are more results available. If there are no more results, no token is included in the response.</p> <p>The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.</p> <p>Using an expired pagination token results in an <code>HTTP 400 InvalidToken</code> error.</p>
13    /// - On failure, responds with [`SdkError<ListRulesError>`](crate::operation::list_rules::ListRulesError)
14    pub fn list_rules(&self) -> crate::operation::list_rules::builders::ListRulesFluentBuilder {
15        crate::operation::list_rules::builders::ListRulesFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_eventbridge/client/list_rules.rs

aws_sdk_eventbridge/client/
list_rules.rs
