AdvertiseByoipCidr - AWS Global Accelerator


Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to AWS 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 AWS Global Accelerator Developer Guide.

Request Syntax

{ "Cidr": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


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.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax

{ "ByoipCidr": { "Cidr": "string", "Events": [ { "Message": "string", "Timestamp": number } ], "State": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Information about the address range.

Type: ByoipCidr object


For information about the errors that are common to all actions, see Common Errors.


You don't have access permission.

HTTP Status Code: 400


The CIDR that you specified was not found or is incorrect.

HTTP Status Code: 400


The CIDR that you specified is not valid for this action. For example, the state of the CIDR might be incorrect for this action.

HTTP Status Code: 400


There was an internal error for AWS Global Accelerator.

HTTP Status Code: 400


An argument that you specified is invalid.

HTTP Status Code: 400


Advertise address range

The following is an example of advertising an address range, and the response.

aws globalaccelerator advertise-byoip-cidr --cidr ""
{ "ByoipCidr": { "Cidr": "", "State": "PENDING_ADVERTISING" } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: