move_byoip_cidr_to_ipam

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',
        'StatusMessage': 'string',
        'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'|'provisioned-not-publicly-advertisable'
    }
}

Response Structure

• (dict) --

  • ByoipCidr (dict) --

    The BYOIP CIDR.

    • Cidr (string) --

      The address range, in CIDR notation.

    • Description (string) --

      The description of the address range.

    • StatusMessage (string) --

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

    • State (string) --

      The state of the address pool.