AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeAddresses operation. Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.DescribeAddressesRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C# 
public class DescribeAddressesRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeAddressesRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeAddressesRequest()

Properties

NameTypeDescription
Public Property AllocationIds System.Collections.Generic.List<System.String>

Gets and sets the property AllocationIds.

[EC2-VPC] Information about the allocation IDs.

Public Property Filters System.Collections.Generic.List<Amazon.EC2.Model.Filter>

Gets and sets the property Filters.

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The Amazon Web Services account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address, or the carrier IP address.

  • tag: - 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.

Public Property PublicIps System.Collections.Generic.List<System.String>

Gets and sets the property PublicIps.

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

Examples

This example describes your Elastic IP addresses.

To describe your Elastic IP addresses


var client = new AmazonEC2Client();
var response = client.DescribeAddresses(new DescribeAddressesRequest 
{
});

List<Address> addresses = response.Addresses;

This example describes your Elastic IP addresses for use with instances in a VPC.

To describe your Elastic IP addresses for EC2-VPC


var client = new AmazonEC2Client();
var response = client.DescribeAddresses(new DescribeAddressesRequest 
{
    Filters = new List<Filter> {
        new Filter {
            Name = "domain",
            Values = new List<string> {
                "vpc"
            }
        }
    }
});

List<Address> addresses = response.Addresses;

This example describes your Elastic IP addresses for use with instances in EC2-Classic.

To describe your Elastic IP addresses for EC2-Classic


var client = new AmazonEC2Client();
var response = client.DescribeAddresses(new DescribeAddressesRequest 
{
    Filters = new List<Filter> {
        new Filter {
            Name = "domain",
            Values = new List<string> {
                "standard"
            }
        }
    }
});

List<Address> addresses = response.Addresses;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5