You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::DescribeAddressesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeAddressesRequest data as a hash:

{
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  public_ips: ["String"],
  allocation_ids: ["String"],
  dry_run: false,
}

Contains the parameters for DescribeAddresses.

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_idsArray<String>

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

Returns:

  • (Array<String>)


6908
6909
6910
6911
6912
6913
6914
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6908

class DescribeAddressesRequest < Struct.new(
  :filters,
  :public_ips,
  :allocation_ids,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


6908
6909
6910
6911
6912
6913
6914
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6908

class DescribeAddressesRequest < Struct.new(
  :filters,
  :public_ips,
  :allocation_ids,
  :dry_run)
  include Aws::Structure
end

#filtersArray<Types::Filter>

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-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS 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.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X 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.

Returns:



6908
6909
6910
6911
6912
6913
6914
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6908

class DescribeAddressesRequest < Struct.new(
  :filters,
  :public_ips,
  :allocation_ids,
  :dry_run)
  include Aws::Structure
end

#public_ipsArray<String>

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

Returns:

  • (Array<String>)


6908
6909
6910
6911
6912
6913
6914
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 6908

class DescribeAddressesRequest < Struct.new(
  :filters,
  :public_ips,
  :allocation_ids,
  :dry_run)
  include Aws::Structure
end