EC2 / Client / move_byoip_cidr_to_ipam

move_byoip_cidr_to_ipam

EC2.Client.move_byoip_cidr_to_ipam(**kwargs)

Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool.

If you already have a BYOIPv4 CIDR with Amazon Web Services, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to Amazon Web Services for the first time, complete the steps in Tutorial: BYOIP address CIDRs to IPAM.

See also: AWS API Documentation

Request Syntax

response = client.move_byoip_cidr_to_ipam(
    DryRun=True|False,
    Cidr='string',
    IpamPoolId='string',
    IpamPoolOwner='string'
)

Parameters:

• DryRun (boolean) – A check for 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.

• Cidr (string) –

  [REQUIRED]

  The BYOIP CIDR.

• IpamPoolId (string) –

  [REQUIRED]

  The IPAM pool ID.

• IpamPoolOwner (string) –

  [REQUIRED]

  The Amazon Web Services account ID of the owner of the IPAM pool.

Return type:

dict

Returns:

Response Syntax

{
    'ByoipCidr': {
        'Cidr': 'string',
        'Description': 'string',
        'AsnAssociations': [
            {
                'Asn': 'string',
                'Cidr': 'string',
                'StatusMessage': 'string',
                'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated'
            },
        ],
        'StatusMessage': 'string',
        'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable',
        'NetworkBorderGroup': 'string'
    }
}

Response Structure

• (dict) –

  • ByoipCidr (dict) –

    The BYOIP CIDR.

    • Cidr (string) –

      The address range, in CIDR notation.

    • Description (string) –

      The description of the address range.

    • AsnAssociations (list) –

      The BYOIP CIDR associations with ASNs.

      • (dict) –

        An Autonomous System Number (ASN) and BYOIP CIDR association.

        • Asn (string) –

          The association’s ASN.

        • Cidr (string) –

          The association’s CIDR.

        • StatusMessage (string) –

          The association’s status message.

        • State (string) –

          The association’s state.

    • StatusMessage (string) –

      Upon success, contains the ID of the address pool. Otherwise, contains an error message.

    • State (string) –

      The state of the address pool.

    • NetworkBorderGroup (string) –

      If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.

      You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:

      • us-east-1-dfw-2

      • us-west-2-lax-1

      • us-west-2-phx-2

      Note

      You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.