amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeAddresses

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.

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.

Synopsis

Creating a Request

data DescribeAddresses Source #

See: newDescribeAddresses smart constructor.

Constructors

DescribeAddresses' 

Fields

  • allocationIds :: Maybe [Text]
    EC2-VPC
    Information about the allocation IDs.
  • dryRun :: Maybe Bool

    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 :: Maybe [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-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:<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 :: Maybe [Text]

    One or more Elastic IP addresses.

    Default: Describes all your Elastic IP addresses.

Instances

Instances details
ToHeaders DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

toHeaders :: DescribeAddresses -> [Header] #

ToPath DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

toPath :: DescribeAddresses -> ByteString #

ToQuery DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

toQuery :: DescribeAddresses -> QueryString #

AWSRequest DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Associated Types

type AWSResponse DescribeAddresses #

Methods

request :: (Service -> Service) -> DescribeAddresses -> Request DescribeAddresses #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAddresses -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAddresses))) #

Generic DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Associated Types

type Rep DescribeAddresses :: Type -> Type #

Methods

from :: DescribeAddresses -> Rep DescribeAddresses x #

to :: Rep DescribeAddresses x -> DescribeAddresses #

Read DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

readsPrec :: Int -> ReadS DescribeAddresses #

readList :: ReadS [DescribeAddresses] #

readPrec :: ReadPrec DescribeAddresses #

readListPrec :: ReadPrec [DescribeAddresses] #

Show DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

showsPrec :: Int -> DescribeAddresses -> ShowS #

show :: DescribeAddresses -> String #

showList :: [DescribeAddresses] -> ShowS #

NFData DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

rnf :: DescribeAddresses -> () #

Eq DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

(==) :: DescribeAddresses -> DescribeAddresses -> Bool #

(/=) :: DescribeAddresses -> DescribeAddresses -> Bool #

Hashable DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

hashWithSalt :: Int -> DescribeAddresses -> Int #

hash :: DescribeAddresses -> Int #

type AWSResponse DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

type AWSResponse DescribeAddresses = DescribeAddressesResponse
type Rep DescribeAddresses Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

type Rep DescribeAddresses = D1 ('MetaData "DescribeAddresses" "Amazonka.EC2.DescribeAddresses" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeAddresses'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allocationIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "publicIps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeAddresses :: DescribeAddresses Source #

Create a value of DescribeAddresses with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allocationIds:DescribeAddresses', describeAddresses_allocationIds - [EC2-VPC] Information about the allocation IDs.

$sel:dryRun:DescribeAddresses', describeAddresses_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.

$sel:filters:DescribeAddresses', describeAddresses_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:<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.

$sel:publicIps:DescribeAddresses', describeAddresses_publicIps - One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

Request Lenses

describeAddresses_allocationIds :: Lens' DescribeAddresses (Maybe [Text]) Source #

EC2-VPC
Information about the allocation IDs.

describeAddresses_dryRun :: Lens' DescribeAddresses (Maybe Bool) Source #

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.

describeAddresses_filters :: Lens' DescribeAddresses (Maybe [Filter]) Source #

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

describeAddresses_publicIps :: Lens' DescribeAddresses (Maybe [Text]) Source #

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

Destructuring the Response

data DescribeAddressesResponse Source #

See: newDescribeAddressesResponse smart constructor.

Constructors

DescribeAddressesResponse' 

Fields

Instances

Instances details
Generic DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Associated Types

type Rep DescribeAddressesResponse :: Type -> Type #

Methods

from :: DescribeAddressesResponse -> Rep DescribeAddressesResponse x #

to :: Rep DescribeAddressesResponse x -> DescribeAddressesResponse #

Read DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

readsPrec :: Int -> ReadS DescribeAddressesResponse #

readList :: ReadS [DescribeAddressesResponse] #

readPrec :: ReadPrec DescribeAddressesResponse #

readListPrec :: ReadPrec [DescribeAddressesResponse] #

Show DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

showsPrec :: Int -> DescribeAddressesResponse -> ShowS #

show :: DescribeAddressesResponse -> String #

showList :: [DescribeAddressesResponse] -> ShowS #

NFData DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

rnf :: DescribeAddressesResponse -> () #

Eq DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

Methods

(==) :: DescribeAddressesResponse -> DescribeAddressesResponse -> Bool #

(/=) :: DescribeAddressesResponse -> DescribeAddressesResponse -> Bool #

type Rep DescribeAddressesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAddresses

type Rep DescribeAddressesResponse = D1 ('MetaData "DescribeAddressesResponse" "Amazonka.EC2.DescribeAddresses" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeAddressesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Address])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeAddressesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeAddressesResponse'

-> DescribeAddressesResponse 

Create a value of DescribeAddressesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeAddressesResponse, describeAddressesResponse_addresses - Information about the Elastic IP addresses.

$sel:httpStatus:DescribeAddressesResponse', describeAddressesResponse_httpStatus - The response's http status code.

Response Lenses

describeAddressesResponse_addresses :: Lens' DescribeAddressesResponse (Maybe [Address]) Source #

Information about the Elastic IP addresses.

describeAddressesResponse_httpStatus :: Lens' DescribeAddressesResponse Int Source #

The response's http status code.