Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

AdvertiseByoipCidr

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.

Cidr

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 AWS Global Accelerator Developer Guide.

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.

ByoipCidr

Information about the address range.

Type: ByoipCidr object

Errors

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

AccessDeniedException

You don't have access permission.

HTTP Status Code: 400

ByoipCidrNotFoundException

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

HTTP Status Code: 400

IncorrectCidrStateException

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

InternalServiceErrorException

There was an internal error for AWS Global Accelerator.

HTTP Status Code: 400

InvalidArgumentException

An argument that you specified is invalid.

HTTP Status Code: 400

Examples

Advertise address range

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


aws globalaccelerator advertise-byoip-cidr --cidr "198.51.100.0/24"


{
    "ByoipCidr": {
        "Cidr": "198.51.100.0/24",
        "State": "PENDING_ADVERTISING"
    }
}