Skip to content

EC2  >  Operations  >  describe_secondary_interfaces

describe_secondary_interfaces

Operation

describe_secondary_interfaces async

describe_secondary_interfaces(request: DescribeSecondaryInterfacesInput | DescribeSecondaryInterfacesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeSecondaryInterfacesOutput
describe_secondary_interfaces(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeSecondaryInterfacesInputDict]) -> DescribeSecondaryInterfacesOutput

Describes one or more of your secondary interfaces.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeSecondaryInterfacesOutput

An instance of DescribeSecondaryInterfacesOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeSecondaryInterfacesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeSecondaryInterfacesInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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 class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

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

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

secondary_interface_ids class-attribute instance-attribute
secondary_interface_ids: list[str] | None = ...

The IDs of the secondary interfaces.

Dictionaries

DescribeSecondaryInterfacesInputDict

Bases: TypedDict

Dictionary form of DescribeSecondaryInterfacesInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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 instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

max_results instance-attribute
max_results: int | None

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

next_token instance-attribute
next_token: str | None

The token for the next page of results.

secondary_interface_ids instance-attribute
secondary_interface_ids: Sequence[str] | None

The IDs of the secondary interfaces.

Output

DescribeSecondaryInterfacesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeSecondaryInterfacesOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

secondary_interfaces class-attribute instance-attribute
secondary_interfaces: list[SecondaryInterface] | None = ...

Information about the secondary interfaces.