aws_sdk_networkfirewall/client/
list_proxy_configurations.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 [`ListProxyConfigurations`](crate::operation::list_proxy_configurations::builders::ListProxyConfigurationsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_proxy_configurations::builders::ListProxyConfigurationsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_proxy_configurations::builders::ListProxyConfigurationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_proxy_configurations::builders::ListProxyConfigurationsFluentBuilder::set_next_token):<br>required: **false**<br><p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_proxy_configurations::builders::ListProxyConfigurationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_proxy_configurations::builders::ListProxyConfigurationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p><br>
9    /// - On success, responds with [`ListProxyConfigurationsOutput`](crate::operation::list_proxy_configurations::ListProxyConfigurationsOutput) with field(s):
10    ///   - [`proxy_configurations(Option<Vec::<ProxyConfigurationMetadata>>)`](crate::operation::list_proxy_configurations::ListProxyConfigurationsOutput::proxy_configurations): <p>The metadata for the proxy configurations. Depending on your setting for max results and the number of proxy configurations that you have, this might not be the full list.</p>
11    ///   - [`next_token(Option<String>)`](crate::operation::list_proxy_configurations::ListProxyConfigurationsOutput::next_token): <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
12    /// - On failure, responds with [`SdkError<ListProxyConfigurationsError>`](crate::operation::list_proxy_configurations::ListProxyConfigurationsError)
13    pub fn list_proxy_configurations(&self) -> crate::operation::list_proxy_configurations::builders::ListProxyConfigurationsFluentBuilder {
14        crate::operation::list_proxy_configurations::builders::ListProxyConfigurationsFluentBuilder::new(self.handle.clone())
15    }
16}