aws_sdk_backupgateway/client/
list_gateways.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 [`ListGateways`](crate::operation::list_gateways::builders::ListGatewaysFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_gateways::builders::ListGatewaysFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_gateways::builders::ListGatewaysFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_gateways::builders::ListGatewaysFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of gateways to list.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_gateways::builders::ListGatewaysFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_gateways::builders::ListGatewaysFluentBuilder::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 [`ListGatewaysOutput`](crate::operation::list_gateways::ListGatewaysOutput) with field(s):
10    ///   - [`gateways(Option<Vec::<Gateway>>)`](crate::operation::list_gateways::ListGatewaysOutput::gateways): <p>A list of your gateways.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_gateways::ListGatewaysOutput::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<ListGatewaysError>`](crate::operation::list_gateways::ListGatewaysError)
13    pub fn list_gateways(&self) -> crate::operation::list_gateways::builders::ListGatewaysFluentBuilder {
14        crate::operation::list_gateways::builders::ListGatewaysFluentBuilder::new(self.handle.clone())
15    }
16}