DescribeAddressesAttributeCommand

Suggest an Edit

Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, DescribeAddressesAttributeCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, DescribeAddressesAttributeCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // DescribeAddressesAttributeRequest
  AllocationIds: [ // AllocationIds
    "STRING_VALUE",
  ],
  Attribute: "domain-name",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  DryRun: true || false,
};
const command = new DescribeAddressesAttributeCommand(input);
const response = await client.send(command);
// { // DescribeAddressesAttributeResult
//   Addresses: [ // AddressSet
//     { // AddressAttribute
//       PublicIp: "STRING_VALUE",
//       AllocationId: "STRING_VALUE",
//       PtrRecord: "STRING_VALUE",
//       PtrRecordUpdate: { // PtrUpdateStatus
//         Value: "STRING_VALUE",
//         Status: "STRING_VALUE",
//         Reason: "STRING_VALUE",
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeAddressesAttributeCommand Input

See DescribeAddressesAttributeCommandInput for more details

Parameter
Type
Description
AllocationIds
string[] | undefined

[EC2-VPC] The allocation IDs.

Attribute
AddressAttributeName | undefined

The attribute of the IP address.

DryRun
boolean | undefined

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.

MaxResults
number | undefined

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 | undefined

The token for the next page of results.

DescribeAddressesAttributeCommand Output

See DescribeAddressesAttributeCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Addresses
AddressAttribute[] | undefined

Information about the IP addresses.

NextToken
string | undefined

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.