aws_sdk_directory/client/list_ip_routes.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 [`ListIpRoutes`](crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`directory_id(impl Into<String>)`](crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder::directory_id) / [`set_directory_id(Option<String>)`](crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder::set_directory_id):<br>required: **true**<br><p>Identifier (ID) of the directory for which you want to retrieve the IP addresses.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder::set_next_token):<br>required: **false**<br><p>The <i>ListIpRoutes.NextToken</i> value from a previous call to <code>ListIpRoutes</code>. Pass null if this is the first call.</p><br>
9 /// - [`limit(i32)`](crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder::set_limit):<br>required: **false**<br><p>Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.</p><br>
10 /// - On success, responds with [`ListIpRoutesOutput`](crate::operation::list_ip_routes::ListIpRoutesOutput) with field(s):
11 /// - [`ip_routes_info(Option<Vec::<IpRouteInfo>>)`](crate::operation::list_ip_routes::ListIpRoutesOutput::ip_routes_info): <p>A list of <code>IpRoute</code>s.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_ip_routes::ListIpRoutesOutput::next_token): <p>If not null, more results are available. Pass this value for the <i>NextToken</i> parameter in a subsequent call to <code>ListIpRoutes</code> to retrieve the next set of items.</p>
13 /// - On failure, responds with [`SdkError<ListIpRoutesError>`](crate::operation::list_ip_routes::ListIpRoutesError)
14 pub fn list_ip_routes(&self) -> crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder {
15 crate::operation::list_ip_routes::builders::ListIpRoutesFluentBuilder::new(self.handle.clone())
16 }
17}