EC2 / Client / describe_secondary_interfaces

describe_secondary_interfaces¶

EC2.Client.describe_secondary_interfaces(**kwargs)¶

Describes one or more of your secondary interfaces.

Request Syntax

response = client.describe_secondary_interfaces(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string',
    SecondaryInterfaceIds=[
        'string',
    ]
)

Parameters:

DryRun (boolean) – 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 (list) –
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.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
MaxResults (integer) – 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 (string) – The token for the next page of results.
SecondaryInterfaceIds (list) –
The IDs of the secondary interfaces.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'SecondaryInterfaces': [
        {
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'Attachment': {
                'AttachmentId': 'string',
                'AttachTime': datetime(2015, 1, 1),
                'DeleteOnTermination': True|False,
                'DeviceIndex': 123,
                'InstanceId': 'string',
                'InstanceOwnerId': 'string',
                'NetworkCardIndex': 123,
                'Status': 'attaching'|'attached'|'detaching'|'detached'
            },
            'MacAddress': 'string',
            'OwnerId': 'string',
            'PrivateIpv4Addresses': [
                {
                    'PrivateIpAddress': 'string'
                },
            ],
            'SecondaryInterfaceId': 'string',
            'SecondaryInterfaceArn': 'string',
            'SecondaryInterfaceType': 'secondary',
            'SecondarySubnetId': 'string',
            'SecondaryNetworkId': 'string',
            'SecondaryNetworkType': 'rdma',
            'SourceDestCheck': True|False,
            'Status': 'available'|'in-use',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- SecondaryInterfaces (list) –
  
  Information about the secondary interfaces.
  - (dict) –
    
    Describes a secondary interface.
    - AvailabilityZone (string) –
      
      The Availability Zone of the secondary interface.
    - AvailabilityZoneId (string) –
      
      The ID of the Availability Zone of the secondary interface.
    - Attachment (dict) –
      
      The attachment information for the secondary interface.
      - AttachmentId (string) –
        
        The ID of the attachment.
      - AttachTime (datetime) –
        
        The timestamp when the attachment was created.
      - DeleteOnTermination (boolean) –
        
        Indicates whether the secondary interface is deleted when the instance is terminated.
        
        The only supported value for this field is true.
      - DeviceIndex (integer) –
        
        The device index of the secondary interface.
      - InstanceId (string) –
        
        The ID of the instance to which the secondary interface is attached.
      - InstanceOwnerId (string) –
        
        The Amazon Web Services account ID of the owner of the instance.
      - NetworkCardIndex (integer) –
        
        The index of the network card.
      - Status (string) –
        
        The attachment state.
    - MacAddress (string) –
      
      The MAC address of the secondary interface.
    - OwnerId (string) –
      
      The ID of the Amazon Web Services account that owns the secondary interface.
    - PrivateIpv4Addresses (list) –
      
      The private IPv4 addresses associated with the secondary interface.
      - (dict) –
        
        Describes a private IPv4 address for a secondary interface.
        
        PrivateIpAddress (string) –
        
        The private IPv4 address.
    - SecondaryInterfaceId (string) –
      
      The ID of the secondary interface.
    - SecondaryInterfaceArn (string) –
      
      The Amazon Resource Name (ARN) of the secondary interface.
    - SecondaryInterfaceType (string) –
      
      The type of secondary interface.
    - SecondarySubnetId (string) –
      
      The ID of the secondary subnet.
    - SecondaryNetworkId (string) –
      
      The ID of the secondary network.
    - SecondaryNetworkType (string) –
      
      The type of the secondary network.
    - SourceDestCheck (boolean) –
      
      Indicates whether source/destination checking is enabled.
    - Status (string) –
      
      The status of the secondary interface.
    - Tags (list) –
      
      The tags assigned to the secondary interface.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.