GlobalAccelerator / Client / advertise_byoip_cidr

advertise_byoip_cidr

GlobalAccelerator.Client.advertise_byoip_cidr(**kwargs)

Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.

To stop advertising the BYOIP address range, use WithdrawByoipCidr.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.advertise_byoip_cidr(
    Cidr='string'
)

Parameters:

Cidr (string) –

[REQUIRED]

The address range, in CIDR notation. This must be the exact range that you provisioned. You can’t advertise only a portion of the provisioned range.

For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

Return type:

dict

Returns:

Response Syntax

{
    'ByoipCidr': {
        'Cidr': 'string',
        'State': 'PENDING_PROVISIONING'|'READY'|'PENDING_ADVERTISING'|'ADVERTISING'|'PENDING_WITHDRAWING'|'PENDING_DEPROVISIONING'|'DEPROVISIONED'|'FAILED_PROVISION'|'FAILED_ADVERTISING'|'FAILED_WITHDRAW'|'FAILED_DEPROVISION',
        'Events': [
            {
                'Message': 'string',
                'Timestamp': datetime(2015, 1, 1)
            },
        ]
    }
}

Response Structure

• (dict) –

  • ByoipCidr (dict) –

    Information about the address range.

    • Cidr (string) –

      The address range, in CIDR notation.

      For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    • State (string) –

      The state of the address pool.

    • Events (list) –

      A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

      • (dict) –

        A complex type that contains a Message and a Timestamp value for changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

        • Message (string) –

          A string that contains an Event message describing changes that you make in the status of an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

        • Timestamp (datetime) –

          A timestamp for when you make a status change for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

Exceptions

• GlobalAccelerator.Client.exceptions.InternalServiceErrorException

• GlobalAccelerator.Client.exceptions.InvalidArgumentException

• GlobalAccelerator.Client.exceptions.AccessDeniedException

• GlobalAccelerator.Client.exceptions.ByoipCidrNotFoundException

• GlobalAccelerator.Client.exceptions.IncorrectCidrStateException