aws_sdk_codestarconnections/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    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`provider_type_filter(ProviderType)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::provider_type_filter) / [`set_provider_type_filter(Option<ProviderType>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_provider_type_filter):<br>required: **false**<br><p>Filters the list of connections to those associated with a specified provider, such as Bitbucket.</p><br>
8    ///   - [`host_arn_filter(impl Into<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::host_arn_filter) / [`set_host_arn_filter(Option<String>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_host_arn_filter):<br>required: **false**<br><p>Filters the list of connections to those associated with a specified host.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_connections::builders::ListConnectionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p><br>
10    ///   - [`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 that was returned from the previous <code>ListConnections</code> call, which can be used to return the next set of connections in the list.</p><br>
11    /// - On success, responds with [`ListConnectionsOutput`](crate::operation::list_connections::ListConnectionsOutput) with field(s):
12    ///   - [`connections(Option<Vec::<Connection>>)`](crate::operation::list_connections::ListConnectionsOutput::connections): <p>A list of connections and the details for each connection, such as status, owner, and provider type.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_connections::ListConnectionsOutput::next_token): <p>A token that can be used in the next <code>ListConnections</code> call. To view all items in the list, continue to call this operation with each subsequent token until no more <code>nextToken</code> values are returned.</p>
14    /// - On failure, responds with [`SdkError<ListConnectionsError>`](crate::operation::list_connections::ListConnectionsError)
15    pub fn list_connections(&self) -> crate::operation::list_connections::builders::ListConnectionsFluentBuilder {
16        crate::operation::list_connections::builders::ListConnectionsFluentBuilder::new(self.handle.clone())
17    }
18}