Skip to content

Describe Secondary Interfaces

ec2_describe_secondary_interfaces R Documentation

Describes one or more of your secondary interfaces

Description

Describes one or more of your secondary interfaces.

Usage

ec2_describe_secondary_interfaces(DryRun, Filters, MaxResults,
  NextToken, SecondaryInterfaceIds)

Arguments

DryRun

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 DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filters

The filters.

  • attachment.attachment-id - The ID of the secondary interface attachment.

  • attachment.instance-id - The ID of the instance to which the secondary interface is attached.

  • attachment.instance-owner-id - The ID of the Amazon Web Services account that owns the instance to which the secondary interface is attached.

  • attachment.status - The attachment status (attaching | attached | detaching | detached).

  • private-ipv4-addresses.private-ip-address - The private IPv4 address associated with the secondary interface.

  • owner-id - The ID of the Amazon Web Services account that owns the secondary interface.

  • secondary-interface-arn - The ARN of the secondary interface.

  • secondary-interface-id - The ID of the secondary interface.

  • secondary-interface-type - The type of secondary interface (secondary).

  • secondary-network-id - The ID of the secondary network.

  • secondary-network-type - The type of the secondary network (rdma).

  • secondary-subnet-id - The ID of the secondary subnet.

  • status - The status of the secondary interface (available | ⁠in-use⁠).

  • tag:\<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 Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - 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.
MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken

The token for the next page of results.
SecondaryInterfaceIds

The IDs of the secondary interfaces.

Value

A list with the following syntax:

list(
  SecondaryInterfaces = list(
    list(
      AvailabilityZone = "string",
      AvailabilityZoneId = "string",
      Attachment = list(
        AttachmentId = "string",
        AttachTime = as.POSIXct(
          "2015-01-01"
        ),
        DeleteOnTermination = TRUE|FALSE,
        DeviceIndex = 123,
        InstanceId = "string",
        InstanceOwnerId = "string",
        NetworkCardIndex = 123,
        Status = "attaching"|"attached"|"detaching"|"detached"
      ),
      MacAddress = "string",
      OwnerId = "string",
      PrivateIpv4Addresses = list(
        list(
          PrivateIpAddress = "string"
        )
      ),
      SecondaryInterfaceId = "string",
      SecondaryInterfaceArn = "string",
      SecondaryInterfaceType = "secondary",
      SecondarySubnetId = "string",
      SecondaryNetworkId = "string",
      SecondaryNetworkType = "rdma",
      SourceDestCheck = TRUE|FALSE,
      Status = "available"|"in-use",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_secondary_interfaces(
  DryRun = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  SecondaryInterfaceIds = list(
    "string"
  )
)