EC2 / Client / deprovision_ipam_byoasn

deprovision_ipam_byoasn#

EC2.Client.deprovision_ipam_byoasn(**kwargs)#

Deprovisions your Autonomous System Number (ASN) from your Amazon Web Services account. This action can only be called after any BYOIP CIDR associations are removed from your Amazon Web Services account with DisassociateIpamByoasn. For more information, see Tutorial: Bring your ASN to IPAM in the Amazon VPC IPAM guide.

See also: AWS API Documentation

Request Syntax

response = client.deprovision_ipam_byoasn(
    DryRun=True|False,
    IpamId='string',
    Asn='string'
)
Parameters:

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

  • IpamId (string) –

    [REQUIRED]

    The IPAM ID.

  • Asn (string) –

    [REQUIRED]

    An ASN.

Return type:

dict

Returns:

Response Syntax

{
    'Byoasn': {
        'Asn': 'string',
        'IpamId': 'string',
        'StatusMessage': 'string',
        'State': 'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'
    }
}

Response Structure

  • (dict) –

    • Byoasn (dict) –

      An ASN and BYOIP CIDR association.

      • Asn (string) –

        A public 2-byte or 4-byte ASN.

      • IpamId (string) –

        An IPAM ID.

      • StatusMessage (string) –

        The status message.

      • State (string) –

        The provisioning state of the BYOASN.