aws_sdk_codestarconnections/client/
list_hosts.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 [`ListHosts`](crate::operation::list_hosts::builders::ListHostsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_hosts::builders::ListHostsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_hosts::builders::ListHostsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_hosts::builders::ListHostsFluentBuilder::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>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_hosts::builders::ListHostsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_hosts::builders::ListHostsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token that was returned from the previous <code>ListHosts</code> call, which can be used to return the next set of hosts in the list.</p><br>
9    /// - On success, responds with [`ListHostsOutput`](crate::operation::list_hosts::ListHostsOutput) with field(s):
10    ///   - [`hosts(Option<Vec::<Host>>)`](crate::operation::list_hosts::ListHostsOutput::hosts): <p>A list of hosts and the details for each host, such as status, endpoint, and provider type.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_hosts::ListHostsOutput::next_token): <p>A token that can be used in the next <code>ListHosts</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>
12    /// - On failure, responds with [`SdkError<ListHostsError>`](crate::operation::list_hosts::ListHostsError)
13    pub fn list_hosts(&self) -> crate::operation::list_hosts::builders::ListHostsFluentBuilder {
14        crate::operation::list_hosts::builders::ListHostsFluentBuilder::new(self.handle.clone())
15    }
16}