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

WithdrawByoipCidr

Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to AWS because of propagation delays.

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.

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 BYOIP address pool.

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

Withdrawing an address range from advertising by

The following is an example of withdrawing an address range from advertising by AWS and the response.


aws globalaccelerator withdraw-byoip-cidr 
    --cidr 203.0.113.25/24


{
    "ByoipCidr": {
        "Cidr": "203.0.113.25/24",
        "State": "PENDING_WITHDRAWING"
    }
}