aws_sdk_backupgateway/client/list_hypervisors.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 [`ListHypervisors`](crate::operation::list_hypervisors::builders::ListHypervisorsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_hypervisors::builders::ListHypervisorsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`max_results(i32)`](crate::operation::list_hypervisors::builders::ListHypervisorsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_hypervisors::builders::ListHypervisorsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of hypervisors to list.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_hypervisors::builders::ListHypervisorsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_hypervisors::builders::ListHypervisorsFluentBuilder::set_next_token):<br>required: **false**<br><p>The next item following a partial list of returned resources. For example, if a request is made to return <code>maxResults</code> number of resources, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p><br>
9 /// - On success, responds with [`ListHypervisorsOutput`](crate::operation::list_hypervisors::ListHypervisorsOutput) with field(s):
10 /// - [`hypervisors(Option<Vec::<Hypervisor>>)`](crate::operation::list_hypervisors::ListHypervisorsOutput::hypervisors): <p>A list of your <code>Hypervisor</code> objects, ordered by their Amazon Resource Names (ARNs).</p>
11 /// - [`next_token(Option<String>)`](crate::operation::list_hypervisors::ListHypervisorsOutput::next_token): <p>The next item following a partial list of returned resources. For example, if a request is made to return <code>maxResults</code> number of resources, <code>NextToken</code> allows you to return more items in your list starting at the location pointed to by the next token.</p>
12 /// - On failure, responds with [`SdkError<ListHypervisorsError>`](crate::operation::list_hypervisors::ListHypervisorsError)
13 pub fn list_hypervisors(&self) -> crate::operation::list_hypervisors::builders::ListHypervisorsFluentBuilder {
14 crate::operation::list_hypervisors::builders::ListHypervisorsFluentBuilder::new(self.handle.clone())
15 }
16}