aws_sdk_ec2/client/
describe_local_gateway_virtual_interfaces.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 [`DescribeLocalGatewayVirtualInterfaces`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`local_gateway_virtual_interface_ids(impl Into<String>)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::local_gateway_virtual_interface_ids) / [`set_local_gateway_virtual_interface_ids(Option<Vec::<String>>)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::set_local_gateway_virtual_interface_ids):<br>required: **false**<br><p>The IDs of the virtual interfaces.</p><br>
8    ///   - [`filters(Filter)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters.</p> <ul>  <li>   <p><code>local-address</code> - The local address.</p></li>  <li>   <p><code>local-bgp-asn</code> - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.</p></li>  <li>   <p><code>local-gateway-id</code> - The ID of the local gateway.</p></li>  <li>   <p><code>local-gateway-virtual-interface-id</code> - The ID of the virtual interface.</p></li>  <li>   <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the local gateway virtual interface.</p></li>  <li>   <p><code>peer-address</code> - The peer address.</p></li>  <li>   <p><code>peer-bgp-asn</code> - The peer BGP ASN.</p></li>  <li>   <p><code>vlan</code> - The ID of the VLAN.</p></li> </ul><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
11    ///   - [`dry_run(bool)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
12    /// - On success, responds with [`DescribeLocalGatewayVirtualInterfacesOutput`](crate::operation::describe_local_gateway_virtual_interfaces::DescribeLocalGatewayVirtualInterfacesOutput) with field(s):
13    ///   - [`local_gateway_virtual_interfaces(Option<Vec::<LocalGatewayVirtualInterface>>)`](crate::operation::describe_local_gateway_virtual_interfaces::DescribeLocalGatewayVirtualInterfacesOutput::local_gateway_virtual_interfaces): <p>Information about the virtual interfaces.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_local_gateway_virtual_interfaces::DescribeLocalGatewayVirtualInterfacesOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
15    /// - On failure, responds with [`SdkError<DescribeLocalGatewayVirtualInterfacesError>`](crate::operation::describe_local_gateway_virtual_interfaces::DescribeLocalGatewayVirtualInterfacesError)
16    pub fn describe_local_gateway_virtual_interfaces(
17        &self,
18    ) -> crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder {
19        crate::operation::describe_local_gateway_virtual_interfaces::builders::DescribeLocalGatewayVirtualInterfacesFluentBuilder::new(
20            self.handle.clone(),
21        )
22    }
23}