Amazon Elastic Compute Cloud

2021/02/03 - Amazon Elastic Compute Cloud - 3 new api methods

Changes  EC2 Public IP now supports API for setting PTR records on Elastic IP address.

ModifyAddressAttribute (new) Link ¶

Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications .

See also: AWS API Documentation

Request Syntax

client.modify_address_attribute(
    AllocationId='string',
    DomainName='string',
    DryRun=True|False
)
type AllocationId

string

param AllocationId

[REQUIRED]

[EC2-VPC] The allocation ID.

type DomainName

string

param DomainName

The domain name to modify for the IP address.

type DryRun

boolean

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

rtype

dict

returns

Response Syntax

{
    'Address': {
        'PublicIp': 'string',
        'AllocationId': 'string',
        'PtrRecord': 'string',
        'PtrRecordUpdate': {
            'Value': 'string',
            'Status': 'string',
            'Reason': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Address (dict) --

      Information about the Elastic IP address.

      • PublicIp (string) --

        The public IP address.

      • AllocationId (string) --

        [EC2-VPC] The allocation ID.

      • PtrRecord (string) --

        The pointer (PTR) record for the IP address.

      • PtrRecordUpdate (dict) --

        The updated PTR record for the IP address.

        • Value (string) --

          The value for the PTR record update.

        • Status (string) --

          The status of the PTR record update.

        • Reason (string) --

          The reason for the PTR record update.

ResetAddressAttribute (new) Link ¶

Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications .

See also: AWS API Documentation

Request Syntax

client.reset_address_attribute(
    AllocationId='string',
    Attribute='domain-name',
    DryRun=True|False
)
type AllocationId

string

param AllocationId

[REQUIRED]

[EC2-VPC] The allocation ID.

type Attribute

string

param Attribute

[REQUIRED]

The attribute of the IP address.

type DryRun

boolean

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

rtype

dict

returns

Response Syntax

{
    'Address': {
        'PublicIp': 'string',
        'AllocationId': 'string',
        'PtrRecord': 'string',
        'PtrRecordUpdate': {
            'Value': 'string',
            'Status': 'string',
            'Reason': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Address (dict) --

      Information about the IP address.

      • PublicIp (string) --

        The public IP address.

      • AllocationId (string) --

        [EC2-VPC] The allocation ID.

      • PtrRecord (string) --

        The pointer (PTR) record for the IP address.

      • PtrRecordUpdate (dict) --

        The updated PTR record for the IP address.

        • Value (string) --

          The value for the PTR record update.

        • Status (string) --

          The status of the PTR record update.

        • Reason (string) --

          The reason for the PTR record update.

DescribeAddressesAttribute (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.describe_addresses_attribute(
    AllocationIds=[
        'string',
    ],
    Attribute='domain-name',
    NextToken='string',
    MaxResults=123,
    DryRun=True|False
)
type AllocationIds

list

param AllocationIds

[EC2-VPC] The allocation IDs.

  • (string) --

type Attribute

string

param Attribute

The attribute of the IP address.

type NextToken

string

param NextToken

The token for the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type DryRun

boolean

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

rtype

dict

returns

Response Syntax

{
    'Addresses': [
        {
            'PublicIp': 'string',
            'AllocationId': 'string',
            'PtrRecord': 'string',
            'PtrRecordUpdate': {
                'Value': 'string',
                'Status': 'string',
                'Reason': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Addresses (list) --

      Information about the IP addresses.

      • (dict) --

        The attributes associated with an Elastic IP address.

        • PublicIp (string) --

          The public IP address.

        • AllocationId (string) --

          [EC2-VPC] The allocation ID.

        • PtrRecord (string) --

          The pointer (PTR) record for the IP address.

        • PtrRecordUpdate (dict) --

          The updated PTR record for the IP address.

          • Value (string) --

            The value for the PTR record update.

          • Status (string) --

            The status of the PTR record update.

          • Reason (string) --

            The reason for the PTR record update.

    • NextToken (string) --

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