aws_sdk_eventbridge/client/
list_connections.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 [`ListConnections`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name_prefix(impl Into<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::name_prefix) / [`set_name_prefix(Option<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_name_prefix):<br>required: **false**<br><p>A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.</p><br>
7    ///   - [`connection_state(ConnectionState)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::connection_state) / [`set_connection_state(Option<ConnectionState>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_connection_state):<br>required: **false**<br><p>The state of the connection.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::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_connections::builders::ListConnectionsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of connections to return.</p><br>
10    /// - On success, responds with [`ListConnectionsOutput`](crate::operation::list_connections::ListConnectionsOutput) with field(s):
11    ///   - [`connections(Option<Vec::<Connection>>)`](crate::operation::list_connections::ListConnectionsOutput::connections): <p>An array of connections objects that include details about the connections.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_connections::ListConnectionsOutput::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<ListConnectionsError>`](crate::operation::list_connections::ListConnectionsError)
14    pub fn list_connections(&self) -> crate::operation::list_connections::builders::ListConnectionsFluentBuilder {
15        crate::operation::list_connections::builders::ListConnectionsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_eventbridge/client/list_connections.rs

aws_sdk_eventbridge/client/
list_connections.rs
