aws_sdk_ec2/client/
describe_outpost_lags.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 [`DescribeOutpostLags`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`outpost_lag_ids(impl Into<String>)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::outpost_lag_ids) / [`set_outpost_lag_ids(Option<Vec::<String>>)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::set_outpost_lag_ids):<br>required: **false**<br><p>The IDs of the Outpost LAGs.</p><br>
7    ///   - [`filters(Filter)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::set_filters):<br>required: **false**<br><p>The filters to use for narrowing down the request. The following filters are supported:</p> <ul>  <li>   <p><code>service-link-virtual-interface-id</code> - The ID of the service link virtual interface.</p></li>  <li>   <p><code>service-link-virtual-interface-arn</code> - The ARN of the service link virtual interface.</p></li>  <li>   <p><code>outpost-id</code> - The Outpost ID.</p></li>  <li>   <p><code>outpost-arn</code> - The Outpost ARN.</p></li>  <li>   <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the service link virtual interface.</p></li>  <li>   <p><code>vlan</code> - The ID of the address pool.</p></li>  <li>   <p><code>local-address</code> - The local address.</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>outpost-lag-id</code> - The Outpost LAG ID.</p></li>  <li>   <p><code>configuration-state</code> - The configuration state of the service link virtual interface.</p></li> </ul><br>
8    ///   - [`max_results(i32)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::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>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
10    ///   - [`dry_run(bool)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::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>
11    /// - On success, responds with [`DescribeOutpostLagsOutput`](crate::operation::describe_outpost_lags::DescribeOutpostLagsOutput) with field(s):
12    ///   - [`outpost_lags(Option<Vec::<OutpostLag>>)`](crate::operation::describe_outpost_lags::DescribeOutpostLagsOutput::outpost_lags): <p>The Outpost LAGs.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::describe_outpost_lags::DescribeOutpostLagsOutput::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>
14    /// - On failure, responds with [`SdkError<DescribeOutpostLagsError>`](crate::operation::describe_outpost_lags::DescribeOutpostLagsError)
15    pub fn describe_outpost_lags(&self) -> crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder {
16        crate::operation::describe_outpost_lags::builders::DescribeOutpostLagsFluentBuilder::new(self.handle.clone())
17    }
18}