aws_sdk_ec2/client/

describe_secondary_interfaces.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeSecondaryInterfaces`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`dry_run(bool)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::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>
    ///   - [`filters(Filter)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::set_filters):<br>required: **false**<br><p>The filters.</p> <ul>  <li>   <p><code>attachment.attachment-id</code> - The ID of the secondary interface attachment.</p></li>  <li>   <p><code>attachment.instance-id</code> - The ID of the instance to which the secondary interface is attached.</p></li>  <li>   <p><code>attachment.instance-owner-id</code> - The ID of the Amazon Web Services account that owns the instance to which the secondary interface is attached.</p></li>  <li>   <p><code>attachment.status</code> - The attachment status (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p></li>  <li>   <p><code>private-ipv4-addresses.private-ip-address</code> - The private IPv4 address associated with the secondary interface.</p></li>  <li>   <p><code>owner-id</code> - The ID of the Amazon Web Services account that owns the secondary interface.</p></li>  <li>   <p><code>secondary-interface-arn</code> - The ARN of the secondary interface.</p></li>  <li>   <p><code>secondary-interface-id</code> - The ID of the secondary interface.</p></li>  <li>   <p><code>secondary-interface-type</code> - The type of secondary interface (<code>secondary</code>).</p></li>  <li>   <p><code>secondary-network-id</code> - The ID of the secondary network.</p></li>  <li>   <p><code>secondary-network-type</code> - The type of the secondary network (<code>rdma</code>).</p></li>  <li>   <p><code>secondary-subnet-id</code> - The ID of the secondary subnet.</p></li>  <li>   <p><code>status</code> - The status of the secondary interface (<code>available</code> | <code>in-use</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> </ul><br>
    ///   - [`max_results(i32)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::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>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
    ///   - [`secondary_interface_ids(impl Into<String>)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::secondary_interface_ids) / [`set_secondary_interface_ids(Option<Vec::<String>>)`](crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::set_secondary_interface_ids):<br>required: **false**<br><p>The IDs of the secondary interfaces.</p><br>
    /// - On success, responds with [`DescribeSecondaryInterfacesOutput`](crate::operation::describe_secondary_interfaces::DescribeSecondaryInterfacesOutput) with field(s):
    ///   - [`secondary_interfaces(Option<Vec::<SecondaryInterface>>)`](crate::operation::describe_secondary_interfaces::DescribeSecondaryInterfacesOutput::secondary_interfaces): <p>Information about the secondary interfaces.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_secondary_interfaces::DescribeSecondaryInterfacesOutput::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>
    /// - On failure, responds with [`SdkError<DescribeSecondaryInterfacesError>`](crate::operation::describe_secondary_interfaces::DescribeSecondaryInterfacesError)
    pub fn describe_secondary_interfaces(
        &self,
    ) -> crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder {
        crate::operation::describe_secondary_interfaces::builders::DescribeSecondaryInterfacesFluentBuilder::new(self.handle.clone())
    }
}