paws.compute (version 0.1.12)

ec2_describe_addresses: Describes the specified Elastic IP addresses or all of your Elastic IP addresses

Description

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.

Usage

ec2_describe_addresses(Filters, PublicIps, AllocationIds, DryRun)

Value

A list with the following syntax:

list(
  Addresses = list(
    list(
      InstanceId = "string",
      PublicIp = "string",
      AllocationId = "string",
      AssociationId = "string",
      Domain = "vpc"|"standard",
      NetworkInterfaceId = "string",
      NetworkInterfaceOwnerId = "string",
      PrivateIpAddress = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      PublicIpv4Pool = "string",
      NetworkBorderGroup = "string",
      CustomerOwnedIp = "string",
      CustomerOwnedIpv4Pool = "string",
      CarrierIp = "string"
    )
  )
)

Arguments

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 AWS 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 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, or the carrier IP address.

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

PublicIps

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

AllocationIds

[EC2-VPC] Information about the allocation IDs.

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.

Request syntax

svc$describe_addresses(
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  PublicIps = list(
    "string"
  ),
  AllocationIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE
)

Examples

if (FALSE) {
# This example describes your Elastic IP addresses.
svc$describe_addresses()

# This example describes your Elastic IP addresses for use with instances
# in a VPC.
svc$describe_addresses(
  Filters = list(
    list(
      Name = "domain",
      Values = list(
        "vpc"
      )
    )
  )
)

# This example describes your Elastic IP addresses for use with instances
# in EC2-Classic.
svc$describe_addresses(
  Filters = list(
    list(
      Name = "domain",
      Values = list(
        "standard"
      )
    )
  )
)
}