aws_sdk_ec2/client/
describe_local_gateway_virtual_interface_groups.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 [`DescribeLocalGatewayVirtualInterfaceGroups`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`local_gateway_virtual_interface_group_ids(impl Into<String>)`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::local_gateway_virtual_interface_group_ids) / [`set_local_gateway_virtual_interface_group_ids(Option<Vec::<String>>)`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::set_local_gateway_virtual_interface_group_ids):<br>required: **false**<br><p>The IDs of the virtual interface groups.</p><br>
8    ///   - [`filters(Filter)`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters.</p> <ul>  <li>   <p><code>local-gateway-id</code> - The ID of a local gateway.</p></li>  <li>   <p><code>local-gateway-virtual-interface-group-id</code> - The ID of the virtual interface group.</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 group.</p></li> </ul><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::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_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::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_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::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 [`DescribeLocalGatewayVirtualInterfaceGroupsOutput`](crate::operation::describe_local_gateway_virtual_interface_groups::DescribeLocalGatewayVirtualInterfaceGroupsOutput) with field(s):
13    ///   - [`local_gateway_virtual_interface_groups(Option<Vec::<LocalGatewayVirtualInterfaceGroup>>)`](crate::operation::describe_local_gateway_virtual_interface_groups::DescribeLocalGatewayVirtualInterfaceGroupsOutput::local_gateway_virtual_interface_groups): <p>The virtual interface groups.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_local_gateway_virtual_interface_groups::DescribeLocalGatewayVirtualInterfaceGroupsOutput::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<DescribeLocalGatewayVirtualInterfaceGroupsError>`](crate::operation::describe_local_gateway_virtual_interface_groups::DescribeLocalGatewayVirtualInterfaceGroupsError)
16    pub fn describe_local_gateway_virtual_interface_groups(
17        &self,
18    ) -> crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder {
19        crate::operation::describe_local_gateway_virtual_interface_groups::builders::DescribeLocalGatewayVirtualInterfaceGroupsFluentBuilder::new(
20            self.handle.clone(),
21        )
22    }
23}