aws_sdk_directconnect/client/describe_hosted_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 [`DescribeHostedConnections`](crate::operation::describe_hosted_connections::builders::DescribeHostedConnectionsFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`connection_id(impl Into<String>)`](crate::operation::describe_hosted_connections::builders::DescribeHostedConnectionsFluentBuilder::connection_id) / [`set_connection_id(Option<String>)`](crate::operation::describe_hosted_connections::builders::DescribeHostedConnectionsFluentBuilder::set_connection_id):<br>required: **true**<br><p>The ID of the interconnect or LAG.</p><br>
7 /// - [`max_results(i32)`](crate::operation::describe_hosted_connections::builders::DescribeHostedConnectionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_hosted_connections::builders::DescribeHostedConnectionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p> <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are returned.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::describe_hosted_connections::builders::DescribeHostedConnectionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_hosted_connections::builders::DescribeHostedConnectionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
9 /// - On success, responds with [`DescribeHostedConnectionsOutput`](crate::operation::describe_hosted_connections::DescribeHostedConnectionsOutput) with field(s):
10 /// - [`connections(Option<Vec::<Connection>>)`](crate::operation::describe_hosted_connections::DescribeHostedConnectionsOutput::connections): <p>The connections.</p>
11 /// - [`next_token(Option<String>)`](crate::operation::describe_hosted_connections::DescribeHostedConnectionsOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
12 /// - On failure, responds with [`SdkError<DescribeHostedConnectionsError>`](crate::operation::describe_hosted_connections::DescribeHostedConnectionsError)
13 pub fn describe_hosted_connections(&self) -> crate::operation::describe_hosted_connections::builders::DescribeHostedConnectionsFluentBuilder {
14 crate::operation::describe_hosted_connections::builders::DescribeHostedConnectionsFluentBuilder::new(self.handle.clone())
15 }
16}