EC2 / Client / provision_ipam_byoasn

provision_ipam_byoasn

EC2.Client.provision_ipam_byoasn(**kwargs)

Provisions your Autonomous System Number (ASN) for use in your Amazon Web Services account. This action requires authorization context for Amazon to bring the ASN to an Amazon Web Services account. 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.provision_ipam_byoasn(
    DryRun=True|False,
    IpamId='string',
    Asn='string',
    AsnAuthorizationContext={
        'Message': 'string',
        'Signature': '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]

  An IPAM ID.

• Asn (string) –

  [REQUIRED]

  A public 2-byte or 4-byte ASN.

• AsnAuthorizationContext (dict) –

  [REQUIRED]

  An ASN authorization context.

  • Message (string) – [REQUIRED]

    The authorization context’s message.

  • Signature (string) – [REQUIRED]

    The authorization context’s signature.

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.