aws_sdk_networkmanager/client/list_peerings.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 [`ListPeerings`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`core_network_id(impl Into<String>)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::core_network_id) / [`set_core_network_id(Option<String>)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::set_core_network_id):<br>required: **false**<br><p>The ID of a core network.</p><br>
8 /// - [`peering_type(PeeringType)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::peering_type) / [`set_peering_type(Option<PeeringType>)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::set_peering_type):<br>required: **false**<br><p>Returns a list of a peering requests.</p><br>
9 /// - [`edge_location(impl Into<String>)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::edge_location) / [`set_edge_location(Option<String>)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::set_edge_location):<br>required: **false**<br><p>Returns a list edge locations for the</p><br>
10 /// - [`state(PeeringState)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::state) / [`set_state(Option<PeeringState>)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::set_state):<br>required: **false**<br><p>Returns a list of the peering request states.</p><br>
11 /// - [`max_results(i32)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
12 /// - [`next_token(impl Into<String>)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
13 /// - On success, responds with [`ListPeeringsOutput`](crate::operation::list_peerings::ListPeeringsOutput) with field(s):
14 /// - [`peerings(Option<Vec::<Peering>>)`](crate::operation::list_peerings::ListPeeringsOutput::peerings): <p>Lists the transit gateway peerings for the <code>ListPeerings</code> request.</p>
15 /// - [`next_token(Option<String>)`](crate::operation::list_peerings::ListPeeringsOutput::next_token): <p>The token for the next page of results.</p>
16 /// - On failure, responds with [`SdkError<ListPeeringsError>`](crate::operation::list_peerings::ListPeeringsError)
17 pub fn list_peerings(&self) -> crate::operation::list_peerings::builders::ListPeeringsFluentBuilder {
18 crate::operation::list_peerings::builders::ListPeeringsFluentBuilder::new(self.handle.clone())
19 }
20}