describe_secondary_interfaces ¶

def describe_secondary_interfaces(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.describe_secondary_interfaces_max_results.DescribeSecondaryInterfacesMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    secondary_interface_ids: Optional[
        "capo_ec2.types.secondary_interface_id_list.SecondaryInterfaceIdList"
    ] = None,
) -> "capo_ec2.types.describe_secondary_interfaces_result.DescribeSecondaryInterfacesResult":
    """<p>Describes one or more of your secondary interfaces.</p>

    Args:
        dry_run: <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>
        filters: <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.</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>
        max_results: <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>
        next_token: <p>The token for the next page of results.</p>
        secondary_interface_ids: <p>The IDs of the secondary interfaces.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe all secondary interfaces
        This example describes all secondary interfaces in the current Region.

        >>> client.describe_secondary_interfaces()
        To describe secondary interfaces using filters
        This example uses filters to describe secondary interfaces attached to a specific instance.

        >>> client.describe_secondary_interfaces(filters=[{'Name': 'attachment.instance-id', 'Values': ['i-1234567890abcdef0']}], max_results=5)
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_secondary_interfaces_request.DescribeSecondaryInterfacesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_secondary_interfaces_result.DescribeSecondaryInterfacesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_secondary_interfaces

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_secondary_interfaces.describe_secondary_interfaces(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSecondaryInterfaces")
    )
    input_: capo_ec2.types.describe_secondary_interfaces_request.DescribeSecondaryInterfacesRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if secondary_interface_ids is not None:
        input_["secondary_interface_ids"] = secondary_interface_ids

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output