EC2 / Client / deprovision_ipam_pool_cidr

deprovision_ipam_pool_cidr#

EC2.Client.deprovision_ipam_pool_cidr(**kwargs)#

Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see Deprovision pool CIDRs in the Amazon VPC IPAM User Guide.

See also: AWS API Documentation

Request Syntax

response = client.deprovision_ipam_pool_cidr(
    DryRun=True|False,
    IpamPoolId='string',
    Cidr='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.

  • IpamPoolId (string) –

    [REQUIRED]

    The ID of the pool that has the CIDR you want to deprovision.

  • Cidr (string) – The CIDR which you want to deprovision from the pool.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPoolCidr': {
        'Cidr': 'string',
        'State': 'pending-provision'|'provisioned'|'failed-provision'|'pending-deprovision'|'deprovisioned'|'failed-deprovision'|'pending-import'|'failed-import',
        'FailureReason': {
            'Code': 'cidr-not-available'|'limit-exceeded',
            'Message': 'string'
        },
        'IpamPoolCidrId': 'string',
        'NetmaskLength': 123
    }
}

Response Structure

  • (dict) –

    • IpamPoolCidr (dict) –

      The deprovisioned pool CIDR.

      • Cidr (string) –

        The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

      • State (string) –

        The state of the CIDR.

      • FailureReason (dict) –

        Details related to why an IPAM pool CIDR failed to be provisioned.

        • Code (string) –

          An error code related to why an IPAM pool CIDR failed to be provisioned.

        • Message (string) –

          A message related to why an IPAM pool CIDR failed to be provisioned.

      • IpamPoolCidrId (string) –

        The IPAM pool CIDR ID.

      • NetmaskLength (integer) –

        The netmask length of the CIDR you’d like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. “NetmaskLength” or “Cidr” is required.