EC2 / Client / describe_ipam_byoasn



Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. 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.describe_ipam_byoasn(
  • 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.

  • MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • NextToken (string) – The token for the next page of results.

Return type:



Response Syntax

    'Byoasns': [
            'Asn': 'string',
            'IpamId': 'string',
            'StatusMessage': 'string',
            'State': 'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-deprovision'|'pending-provision'|'provisioned'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • Byoasns (list) –

      ASN and BYOIP CIDR associations.

      • (dict) –

        The Autonomous System Number (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.

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