Skip to main content

aws_sdk_ec2/client/
describe_secondary_networks.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 [`DescribeSecondaryNetworks`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`dry_run(bool)`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::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>
8    ///   - [`filters(Filter)`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::set_filters):<br>required: **false**<br><p>The filters. The following are the possible values:</p> <ul>  <li>   <p><code>ipv4-cidr-block-association.association-id</code> - The association ID for an IPv4 CIDR block associated with the secondary network.</p></li>  <li>   <p><code>ipv4-cidr-block-association.cidr-block</code> - An IPv4 CIDR block associated with the secondary network.</p></li>  <li>   <p><code>ipv4-cidr-block-association.state</code> - The state of an IPv4 CIDR block associated with the secondary network.</p></li>  <li>   <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the secondary network.</p></li>  <li>   <p><code>secondary-network-id</code> - The ID of the secondary network.</p></li>  <li>   <p><code>secondary-network-arn</code> - The ARN of the secondary network.</p></li>  <li>   <p><code>state</code> - The state of the secondary network (<code>create-in-progress</code> | <code>create-complete</code> | <code>create-failed</code> | <code>delete-in-progress</code> | <code>delete-complete</code> | <code>delete-failed</code>).</p></li>  <li>   <p><code>tag</code>:<key>     - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key      <code>Owner</code> and the value      <code>TeamA</code>, specify      <code>tag:Owner</code> for the filter name and      <code>TeamA</code> for the filter value.    </key></p></li>  <li>   <p><code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.</p></li>  <li>   <p><code>type</code> - The type of the secondary network (<code>rdma</code>).</p></li> </ul><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::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_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
11    ///   - [`secondary_network_ids(impl Into<String>)`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::secondary_network_ids) / [`set_secondary_network_ids(Option<Vec::<String>>)`](crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::set_secondary_network_ids):<br>required: **false**<br><p>The IDs of the secondary networks.</p><br>
12    /// - On success, responds with [`DescribeSecondaryNetworksOutput`](crate::operation::describe_secondary_networks::DescribeSecondaryNetworksOutput) with field(s):
13    ///   - [`secondary_networks(Option<Vec::<SecondaryNetwork>>)`](crate::operation::describe_secondary_networks::DescribeSecondaryNetworksOutput::secondary_networks): <p>Information about the secondary networks.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_secondary_networks::DescribeSecondaryNetworksOutput::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<DescribeSecondaryNetworksError>`](crate::operation::describe_secondary_networks::DescribeSecondaryNetworksError)
16    pub fn describe_secondary_networks(&self) -> crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder {
17        crate::operation::describe_secondary_networks::builders::DescribeSecondaryNetworksFluentBuilder::new(self.handle.clone())
18    }
19}